FHIR Core Implementation Guide (CO)
0.1.0 - STU1
FHIR Core Implementation Guide (CO) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://co.fhir.guide/core/StructureDefinition/CareDeliveryLocationCO | Version: 0.1.0 | |||
Draft as of 2024-11-19 | Computable Name: CareDeliveryLocationCO | |||
Copyright/Legal: HL7 Colombia, CC-BY-4.0, 2024+ |
FHIR Core profile of Colombian care delivery locations, defined by HL7 CO.
Recording and tracking information from a point of care (location) of a care delivery organization or institution.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Description of availability exceptions | |
meta | ||||
profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/CareDeliveryLocationCO | |
identifier | 1..* | Identifier | Healthcare location identifier | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | |
value | 1..1 | string | Healthcare location identifier value | |
status | S | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
name | S | 1..1 | string | Name of the location as used by humans |
description | 0..1 | string | Description of the Location, which helps in finding or referencing the place. | |
mode | 0..1 | code | instance | kind Binding: LocationMode (required) | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: HOSP | |
display | 0..1 | string | Representation defined by the system Fixed Value: Hospital | |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: +57(000)000-0000 | |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: (000)000-0000 | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile | |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
value | 1..1 | string | Syntax: info@example.com | |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
value | 1..1 | string | Syntax: http://example.com | |
address | 1..1 | Address | Main address of the point of care location | |
use | 1..1 | code | home | work | temp | old | billing - purpose of this address Fixed Value: work | |
type | 1..1 | code | postal | physical | both Fixed Value: physical | |
text | 1..1 | string | Text representation of the address | |
city | S | 1..1 | string | Colombian municipality |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaMunicipality | 0..1 | Coding | Divipola municipality code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaMunicipality Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAmunicipalities (required) | |
district | 0..1 | string | District, locality or commune | |
state | S | 1..1 | string | Colombian Department |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaDepartment | 0..1 | Coding | Divipola department code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaDepartment Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAdepartments (required) | |
country | S | 1..1 | string | Country Fixed Value: CO |
managingOrganization | S | 1..1 | Reference(Profile: Care Delivery Organization CO) | Organization responsible for provisioning and upkeep |
hoursOfOperation | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | |
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Description of availability exceptions | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Healthcare location identifier |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS |
value | Σ | 1..1 | string | Healthcare location identifier value Example General: 123456 |
status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
name | SΣ | 1..1 | string | Name of the location as used by humans |
description | Σ | 0..1 | string | Description of the Location, which helps in finding or referencing the place. |
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required) |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: (000)000-0000 |
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | Σ | 1..1 | string | Syntax: info@example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
value | Σ | 1..1 | string | Syntax: http://example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | 1..1 | Address | Main address of the point of care location | |
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work |
type | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical |
text | Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
city | SΣ | 1..1 | string | Colombian municipality Example General: Erewhon |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaMunicipality | S | 0..1 | Coding | Divipola municipality code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaMunicipality Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAmunicipalities (required) |
district | Σ | 0..1 | string | District, locality or commune Example General: Madison |
state | SΣ | 1..1 | string | Colombian Department |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaDepartment | S | 0..1 | Coding | Divipola department code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaDepartment Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAdepartments (required) |
country | SΣ | 1..1 | string | Country Fixed Value: CO |
managingOrganization | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Organization responsible for provisioning and upkeep |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Location.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.address.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Location.address.type | required | Fixed Value: physicalhttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Description of availability exceptions | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/CareDeliveryLocationCO | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Healthcare location identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | ||||
value | Σ | 1..1 | string | Healthcare location identifier value Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) | ||||
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
name | SΣ | 1..1 | string | Name of the location as used by humans | ||||
alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
description | Σ | 0..1 | string | Description of the Location, which helps in finding or referencing the place. | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required) | ||||
type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: HOSP | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: Hospital | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |||||
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: (000)000-0000 | ||||
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | Σ | 1..1 | string | Syntax: info@example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
value | Σ | 1..1 | string | Syntax: http://example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | 1..1 | Address | Main address of the point of care location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work | ||||
type | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical | ||||
text | Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | SΣ | 1..1 | string | Colombian municipality Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ExtensionDivipolaMunicipality | S | 0..1 | Coding | Divipola municipality code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaMunicipality Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAmunicipalities (required) | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
district | Σ | 0..1 | string | District, locality or commune Example General: Madison | ||||
state | SΣ | 1..1 | string | Colombian Department | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ExtensionDivipolaDepartment | S | 0..1 | Coding | Divipola department code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaDepartment Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAdepartments (required) | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | SΣ | 1..1 | string | Country Fixed Value: CO | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
position | 0..1 | BackboneElement | The absolute geographic location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Location.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Location.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Location.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.address.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Location.address.type | required | Fixed Value: physicalhttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Location
Summary
Mandatory: 12 elements(13 nested mandatory elements)
Must-Support: 6 elements
Fixed: 13 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Description of availability exceptions | |
meta | ||||
profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/CareDeliveryLocationCO | |
identifier | 1..* | Identifier | Healthcare location identifier | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: official | |
system | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | |
value | 1..1 | string | Healthcare location identifier value | |
status | S | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
name | S | 1..1 | string | Name of the location as used by humans |
description | 0..1 | string | Description of the Location, which helps in finding or referencing the place. | |
mode | 0..1 | code | instance | kind Binding: LocationMode (required) | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: HOSP | |
display | 0..1 | string | Representation defined by the system Fixed Value: Hospital | |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: +57(000)000-0000 | |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone | |
value | 1..1 | string | Syntax: (000)000-0000 | |
use | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile | |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
value | 1..1 | string | Syntax: info@example.com | |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: url | |
value | 1..1 | string | Syntax: http://example.com | |
address | 1..1 | Address | Main address of the point of care location | |
use | 1..1 | code | home | work | temp | old | billing - purpose of this address Fixed Value: work | |
type | 1..1 | code | postal | physical | both Fixed Value: physical | |
text | 1..1 | string | Text representation of the address | |
city | S | 1..1 | string | Colombian municipality |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaMunicipality | 0..1 | Coding | Divipola municipality code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaMunicipality Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAmunicipalities (required) | |
district | 0..1 | string | District, locality or commune | |
state | S | 1..1 | string | Colombian Department |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaDepartment | 0..1 | Coding | Divipola department code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaDepartment Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAdepartments (required) | |
country | S | 1..1 | string | Country Fixed Value: CO |
managingOrganization | S | 1..1 | Reference(Profile: Care Delivery Organization CO) | Organization responsible for provisioning and upkeep |
hoursOfOperation | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | |
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | Location | Description of availability exceptions | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Healthcare location identifier |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official |
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS |
value | Σ | 1..1 | string | Healthcare location identifier value Example General: 123456 |
status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
name | SΣ | 1..1 | string | Name of the location as used by humans |
description | Σ | 0..1 | string | Description of the Location, which helps in finding or referencing the place. |
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required) |
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
value | Σ | 1..1 | string | Syntax: (000)000-0000 |
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile |
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | Σ | 1..1 | string | Syntax: info@example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url |
value | Σ | 1..1 | string | Syntax: http://example.com |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | 1..1 | Address | Main address of the point of care location | |
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work |
type | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical |
text | Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
city | SΣ | 1..1 | string | Colombian municipality Example General: Erewhon |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaMunicipality | S | 0..1 | Coding | Divipola municipality code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaMunicipality Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAmunicipalities (required) |
district | Σ | 0..1 | string | District, locality or commune Example General: Madison |
state | SΣ | 1..1 | string | Colombian Department |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ExtensionDivipolaDepartment | S | 0..1 | Coding | Divipola department code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaDepartment Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAdepartments (required) |
country | SΣ | 1..1 | string | Country Fixed Value: CO |
managingOrganization | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Organization responsible for provisioning and upkeep |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Location.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Location.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Location.address.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Location.address.type | required | Fixed Value: physicalhttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | Location | Description of availability exceptions | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: http://co.fhir.guide/core/StructureDefinition/CareDeliveryLocationCO | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Healthcare location identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: http://co.fhir.guide/NamingSystem/REPS | ||||
value | Σ | 1..1 | string | Healthcare location identifier value Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) | ||||
operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
name | SΣ | 1..1 | string | Name of the location as used by humans | ||||
alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
description | Σ | 0..1 | string | Description of the Location, which helps in finding or referencing the place. | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required) | ||||
type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: HOSP | ||||
display | Σ | 0..1 | string | Representation defined by the system Fixed Value: Hospital | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for telecom | 0..* | ContactPoint | Telephone, mobile, email, etc. Slice: Unordered, Open by value:id | |||||
telecom:TelecomPhone | 0..* | ContactPoint | Telephone | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomPhone-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: +57(000)000-0000 | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomMobile | 0..* | ContactPoint | Mobile | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomMobile-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 1..1 | string | Syntax: (000)000-0000 | ||||
use | ?!Σ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomEmail | 0..* | ContactPoint | E-mail | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomEmail-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | Σ | 1..1 | string | Syntax: info@example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:TelecomURL | 0..* | ContactPoint | Web Site | |||||
id | 1..1 | string | Unique id for inter-element referencing Required Pattern: TelecomURL-0 | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url | ||||
value | Σ | 1..1 | string | Syntax: http://example.com | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | 1..1 | Address | Main address of the point of care location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: work | ||||
type | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Fixed Value: physical | ||||
text | Σ | 1..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | SΣ | 1..1 | string | Colombian municipality Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ExtensionDivipolaMunicipality | S | 0..1 | Coding | Divipola municipality code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaMunicipality Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAmunicipalities (required) | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
district | Σ | 0..1 | string | District, locality or commune Example General: Madison | ||||
state | SΣ | 1..1 | string | Colombian Department | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ExtensionDivipolaDepartment | S | 0..1 | Coding | Divipola department code URL: http://co.fhir.guide/core/StructureDefinition/ExtensionDivipolaDepartment Binding: http://terminology.fhir.guide/co/ValueSet/DIVIPOLAdepartments (required) | ||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | |||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | SΣ | 1..1 | string | Country Fixed Value: CO | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
position | 0..1 | BackboneElement | The absolute geographic location | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Longitude with WGS84 datum | |||||
latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | SΣ | 1..1 | Reference(Profile: Care Delivery Organization CO) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Location.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Location.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.identifier.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Location.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.telecom:TelecomPhone.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomPhone.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomMobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomMobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomEmail.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomEmail.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomURL.system | required | Fixed Value: urlhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Location.telecom:TelecomURL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Location.address.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Location.address.type | required | Fixed Value: physicalhttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |