FHIR Human Services Directory
1.0.0 - STU1 United States of America flag

FHIR Human Services Directory, published by HL7 Human and Social Services Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/FHIR-IG-Human-Services-Directory/ and changes regularly. See the Directory of published versions

Resource Profile: HSDLocation - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the hsds-Location resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Location
2. Location.meta
4. Location.meta.lastUpdated
Control1..?
6. Location.text
8. Location.extension
SlicingThis element introduces a set of slices on Location.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
10. Location.extension:newpatients
Slice Namenewpatients
Control0..0
TypeExtension(New Patients) (Complex Extension)
12. Location.extension:accessibility
Slice Nameaccessibility
ShortAccessibility
Control0..*
TypeExtension(Accessibility) (Extension Type: CodeableConcept)
14. Location.extension:location-boundary-geojson
Slice Namelocation-boundary-geojson
ShortAssociated Region (GeoJSON)
Control0..1
TypeExtension(Boundary (GeoJSON)) (Extension Type: Attachment)
16. Location.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
18. Location.identifier.id
20. Location.identifier.use
Fixed Valueofficial
22. Location.identifier.type
Must Supporttrue
24. Location.identifier.system
26. Location.identifier.value
Must Supporttrue
28. Location.identifier.period
30. Location.identifier.assigner
32. Location.status
Control1..?
Fixed Valueactive
34. Location.name
36. Location.alias
38. Location.description
40. Location.mode
Control0..0
42. Location.type
Control0..0
44. Location.telecom
46. Location.telecom.extension
48. Location.telecom.extension:contactpoint-availabletime
Slice Namecontactpoint-availabletime
Control0..0
TypeExtension(Contactpoint Availabletime) (Complex Extension)
Must Supporttrue
50. Location.telecom.extension:via-intermediary
Slice Namevia-intermediary
ShortVia Intermediary
Control0..0
TypeExtension(Via Intermediary) (Extension Type: Reference(Plan-Net PractitionerRole, Plan-Net OrganizationAffiliation, Plan-Net Location, Plan-Net Organization))
Must Supporttrue
52. Location.telecom.system
Must Supporttrue
54. Location.telecom.value
Must Supporttrue
56. Location.telecom.use
Fixed Valuework
58. Location.telecom.rank
60. Location.telecom.period
62. Location.address
64. Location.address.id
66. Location.address.use
Fixed Valuework
68. Location.address.type
70. Location.address.text
72. Location.address.line
74. Location.address.city
76. Location.address.district
78. Location.address.state
80. Location.address.postalCode
82. Location.address.country
84. Location.address.period
86. Location.physicalType
88. Location.position
Must Supporttrue
90. Location.position.id
92. Location.position.longitude
94. Location.position.latitude
96. Location.position.altitude
98. Location.managingOrganization
TypeReference(HSDOrganization)
100. Location.partOf
Control0..0
102. Location.hoursOfOperation
Must Supporttrue
104. Location.hoursOfOperation.id
106. Location.hoursOfOperation.daysOfWeek
Must Supporttrue
108. Location.hoursOfOperation.allDay
Must Supporttrue
110. Location.hoursOfOperation.openingTime
Must Supporttrue
112. Location.hoursOfOperation.closingTime
Must Supporttrue
114. Location.availabilityExceptions
Must Supporttrue
116. Location.endpoint

Guidance on how to interpret the contents of this table can be found here

0. Location
Definition

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

ShortDetails and position information for a physical place
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Location.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Location.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

ShortWhen the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control10..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Location.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Location.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Location.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
12. Location.extension:newpatients
Slice Namenewpatients
Definition

New Patients indicates whether new patients are being accepted in general, or from a specific network.
This extension is included in the PractitionerRole, HealthcareService, and Location profiles.
This provides needed flexibility for specifying whether a provider accepts new patients by location and network.

ShortNew Patients
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension(New Patients) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed (extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty())
14. Location.extension:accessibility
Slice Nameaccessibility
Definition

An extension to describe accessibility options offered by a practitioner or at a location.

ShortAccessibility
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Accessibility) (Extension Type: CodeableConcept)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Location.extension:location-boundary-geojson
Slice Namelocation-boundary-geojson
Definition

A boundary shape that represents the outside edge of the location (in GeoJSON format) This shape may have holes, and disconnected shapes.

ShortAssociated Region (GeoJSON)
Comments

The format of the content is GeoJSON in both the JSON and XML formats. It will be stored in the resource using the .data property, and externally referenced via the URL property. The mimetype to be used will be 'application/geo+json'.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Boundary (GeoJSON)) (Extension Type: Attachment)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Location.identifier
Definition

Unique code or number identifying the location to its users.

ShortUnique code or number identifying the location to its users
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Requirements

Organization label locations in registries, need to keep track of those.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Location.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
24. Location.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Fixed Valueofficial
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Location.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Location.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Location.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Location.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Location.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Location.status
Definition

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Shortactive | suspended | inactive
Control10..1
BindingThe codes SHALL be taken from LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1

Indicates whether the location is still in use.

Typecode
Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valueactive
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Location.name
Definition

Name of the location as used by humans. Does not need to be unique.

ShortName of the location as used by humans
Comments

If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Location.alias
Definition

A list of alternate names that the location is known as, or was known as, in the past.

ShortA list of alternate names that the location is known as, or was known as, in the past
Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the location was known by can be very useful.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Location.description
Definition

Description of the Location, which helps in finding or referencing the place.

ShortAdditional details about the location that could be displayed as further information to identify the location beyond its name
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Humans need additional information to verify a correct location has been identified.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Location.mode
Definition

Indicates whether a resource instance represents a specific location or a class of locations.

Shortinstance | kind
Comments

This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.

Control0..01
BindingThe codes SHALL be taken from LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1

Indicates whether a resource instance represents a specific location or a class of locations.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Location.type
Definition

Indicates the type of function performed at the location.

ShortType of function performed
Control0..0*
BindingUnless not suitable, these codes SHALL be taken from ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType

Indicates the type of function performed at the location.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Location.telecom
Definition

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

ShortContact details of the location
Control0..*
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Location.telecom.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
52. Location.telecom.extension:contactpoint-availabletime
Slice Namecontactpoint-availabletime
Definition

An extension representing the days and times a contact point is available

ShortContactpoint Availabletime
Control0..0
TypeExtension(Contactpoint Availabletime) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
54. Location.telecom.extension:via-intermediary
Slice Namevia-intermediary
Definition

A reference to an alternative point of contact (plannet-PractitionerRole, plannet-Organization, plannet-OrganizationAffiliation, or plannet-Location) for this organization

ShortVia Intermediary
Control0..0
TypeExtension(Via Intermediary) (Extension Type: Reference(Plan-Net PractitionerRole, Plan-Net OrganizationAffiliation, Plan-Net Location, Plan-Net Organization))
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
56. Location.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Shortphone | fax | email | pager | url | sms | other
Control0..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1

Telecommunications form for contact point.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Location.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

ShortThe actual contact point details
Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Location.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1

Use of contact point.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Fixed Valuework
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Location.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

ShortSpecify preferred order of use (1 = highest)
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Location.telecom.period
Definition

Time period when the contact point was/is in use.

ShortTime period when the contact point was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Location.address
Definition

Physical location.

ShortPhysical location
Comments

Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

Control0..1
TypeAddress
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

If locations can be visited, we need to keep track of their address.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Location.address.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
70. Location.address.use
Definition

The purpose of this address.

Shorthome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1

The use of an address.

Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Fixed Valuework
Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Location.address.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1

The type of an address (physical / postal).

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Location.address.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText representation of the address
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

A renderable, unencoded form.

Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Location.address.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortStreet name, number, direction & P.O. Box etc.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Example<br/><b>General</b>:137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Location.address.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortName of city, town etc.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
Example<br/><b>General</b>:Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Location.address.district
Definition

The name of the administrative area (county).

ShortDistrict name (aka county)
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesCounty
Example<br/><b>General</b>:Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Location.address.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortSub-unit of country (abbreviations ok)
Control0..1
BindingUnless not suitable, these codes SHALL be taken from For codes, see USPS Two Letter Alphabetic Codes: Two letter USPS alphabetic codes.
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Location.address.postalCode
Definition

A postal code designating a region defined by the postal service.

ShortUS Zip CodesPostal code for area
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesZip
Example<br/><b>General</b>:9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Location.address.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Location.address.period
Definition

Time period when address was/is in use.

ShortTime period when address was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Requirements

Allows addresses to be placed in historical context.

Example<br/><b>General</b>:&lt;valuePeriod&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;start&nbsp;value=&quot;2010-03-23&quot;/&gt;<br/>&nbsp;&nbsp;&lt;end&nbsp;value=&quot;2010-07-01&quot;/&gt;<br/>&lt;/valuePeriod&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Location.physicalType
Definition

Physical form of the location, e.g. building, room, vehicle, road.

ShortPhysical form of the location
Control0..1
BindingFor example codes, see LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type

Physical form of the location.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

For purposes of showing relevant locations in queries, we need to categorize locations.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Location.position
Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

ShortThe absolute geographic location
Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

For mobile applications and automated route-finding knowing the exact location of the Location is required.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Location.position.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
96. Location.position.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
98. Location.position.longitude
Definition

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

ShortLongitude with WGS84 datum
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Location.position.latitude
Definition

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

ShortLatitude with WGS84 datum
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Location.position.altitude
Definition

Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

ShortAltitude with WGS84 datum
Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Location.managingOrganization
Definition

The organization responsible for the provisioning and upkeep of the location.

ShortOrganization responsible for provisioning and upkeep
Comments

This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

Control0..1
TypeReference(HSDOrganization, Organization)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to know who manages the location.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Location.partOf
Definition

Another Location of which this Location is physically a part of.

ShortAnother Location this one is physically a part of
Control0..01
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Requirements

For purposes of location, display and identification, knowing which locations are located within other locations is important.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Location.hoursOfOperation
Definition

What days/times during a week is this location usually open.

ShortWhat days/times during a week is this location usually open
Comments

This type of information is commonly found published in directories and on websites informing customers when the facility is available.

Specific services within the location may have their own hours which could be shorter (or longer) than the locations hours.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Location.hoursOfOperation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
112. Location.hoursOfOperation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
114. Location.hoursOfOperation.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Shortmon | tue | wed | thu | fri | sat | sun
Control0..*
BindingThe codes SHALL be taken from DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1

The days of the week.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. Location.hoursOfOperation.allDay
Definition

The Location is open all day.

ShortThe Location is open all day
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Location.hoursOfOperation.openingTime
Definition

Time that the Location opens.

ShortTime that the Location opens
Control0..1
Typetime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. Location.hoursOfOperation.closingTime
Definition

Time that the Location closes.

ShortTime that the Location closes
Control0..1
Typetime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. Location.availabilityExceptions
Definition

A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

ShortDescription of availability exceptions
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Location.endpoint
Definition

Technical endpoints providing access to services operated for the location.

ShortTechnical endpoints providing access to services operated for the location
Control0..*
TypeReference(Endpoint)
Is Modifierfalse
Summaryfalse
Requirements

Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Location
Definition

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

ShortDetails and position information for a physical place
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Location.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. Location.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Location.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. Location.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
10. Location.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

ShortVersion specific identifier
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Location.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

ShortWhen the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control1..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Location.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

ShortIdentifies where the resource comes from
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Location.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Location.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

ShortSecurity Labels applied to this resource
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from All Security Labels: Security Labels from the Healthcare Privacy and Security Classification System.
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Location.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

ShortTags applied to this resource
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
BindingFor example codes, see CommonTags: Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Location.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Location.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages: A human language.
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Location.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Location.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
30. Location.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
32. Location.extension:newpatients
Slice Namenewpatients
Definition

New Patients indicates whether new patients are being accepted in general, or from a specific network.
This extension is included in the PractitionerRole, HealthcareService, and Location profiles.
This provides needed flexibility for specifying whether a provider accepts new patients by location and network.

ShortNew Patients
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension(New Patients) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed (extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty())
34. Location.extension:accessibility
Slice Nameaccessibility
Definition

An extension to describe accessibility options offered by a practitioner or at a location.

ShortAccessibility
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Accessibility) (Extension Type: CodeableConcept)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Location.extension:location-boundary-geojson
Slice Namelocation-boundary-geojson
Definition

A boundary shape that represents the outside edge of the location (in GeoJSON format) This shape may have holes, and disconnected shapes.

ShortAssociated Region (GeoJSON)
Comments

The format of the content is GeoJSON in both the JSON and XML formats. It will be stored in the resource using the .data property, and externally referenced via the URL property. The mimetype to be used will be 'application/geo+json'.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Boundary (GeoJSON)) (Extension Type: Attachment)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. Location.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. Location.identifier
Definition

Unique code or number identifying the location to its users.

ShortUnique code or number identifying the location to its users
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Requirements

Organization label locations in registries, need to keep track of those.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Location.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
44. Location.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
46. Location.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse: Identifies the purpose for this identifier, if known .
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Fixed Valueofficial
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Location.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Location.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Location.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Location.identifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Location.identifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Location.status
Definition

The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.

Shortactive | suspended | inactive
Control1..1
BindingThe codes SHALL be taken from LocationStatus: Indicates whether the location is still in use.
Typecode
Is Modifiertrue because This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Fixed Valueactive
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Location.operationalStatus
Definition

The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.

ShortThe operational status of the location (typically only for a bed/room)
Control0..1
BindingThe codes SHOULD be taken from hl7VS-bedStatus: The operational status if the location (where typically a bed/room).
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Location.name
Definition

Name of the location as used by humans. Does not need to be unique.

ShortName of the location as used by humans
Comments

If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Location.alias
Definition

A list of alternate names that the location is known as, or was known as, in the past.

ShortA list of alternate names that the location is known as, or was known as, in the past
Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.

Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Over time locations and organizations go through many changes and can be known by different names.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Location.description
Definition

Description of the Location, which helps in finding or referencing the place.

ShortAdditional details about the location that could be displayed as further information to identify the location beyond its name
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Humans need additional information to verify a correct location has been identified.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Location.mode
Definition

Indicates whether a resource instance represents a specific location or a class of locations.

Shortinstance | kind
Comments

This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.

Control0..0
BindingThe codes SHALL be taken from LocationMode: Indicates whether a resource instance represents a specific location or a class of locations.
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Location.type
Definition

Indicates the type of function performed at the location.

ShortType of function performed
Control0..0
BindingUnless not suitable, these codes SHALL be taken from ServiceDeliveryLocationRoleType: Indicates the type of function performed at the location.
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Location.telecom
Definition

The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.

ShortContact details of the location
Control0..*
TypeContactPoint
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Location.telecom.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
76. Location.telecom.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
78. Location.telecom.extension:contactpoint-availabletime
Slice Namecontactpoint-availabletime
Definition

An extension representing the days and times a contact point is available

ShortContactpoint Availabletime
Control0..0
TypeExtension(Contactpoint Availabletime) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
80. Location.telecom.extension:via-intermediary
Slice Namevia-intermediary
Definition

A reference to an alternative point of contact (plannet-PractitionerRole, plannet-Organization, plannet-OrganizationAffiliation, or plannet-Location) for this organization

ShortVia Intermediary
Control0..0
TypeExtension(Via Intermediary) (Extension Type: Reference(Plan-Net PractitionerRole, Plan-Net OrganizationAffiliation, Plan-Net Location, Plan-Net Organization))
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
82. Location.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Shortphone | fax | email | pager | url | sms | other
Control0..1
This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystem: Telecommunications form for contact point.
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Location.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

ShortThe actual contact point details
Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Location.telecom.use
Definition

Identifies the purpose for the contact point.

Shorthome | work | temp | old | mobile - purpose of this contact point
Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from ContactPointUse: Use of contact point.
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Fixed Valuework
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Location.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

ShortSpecify preferred order of use (1 = highest)
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Control0..1
TypepositiveInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Location.telecom.period
Definition

Time period when the contact point was/is in use.

ShortTime period when the contact point was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Location.address
Definition

Physical location.

ShortPhysical location
Comments

Additional addresses should be recorded using another instance of the Location resource, or via the Organization.

Control0..1
TypeAddress
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

If locations can be visited, we need to keep track of their address.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Location.address.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
96. Location.address.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Location.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
98. Location.address.use
Definition

The purpose of this address.

Shorthome | work | temp | old | billing - purpose of this address
Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Control0..1
BindingThe codes SHALL be taken from AddressUse: The use of an address.
Typecode
Is Modifiertrue because This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary or old address etc.for a current/permanent one
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Fixed Valuework
Example<br/><b>General</b>:home
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Location.address.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Shortpostal | physical | both
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Control0..1
BindingThe codes SHALL be taken from AddressType: The type of an address (physical / postal).
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:both
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Location.address.text
Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

ShortText representation of the address
Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

A renderable, unencoded form.

Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Location.address.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

ShortStreet name, number, direction & P.O. Box etc.
Control0..*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Example<br/><b>General</b>:137 Nowhere Street
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Location.address.city
Definition

The name of the city, town, suburb, village or other community or delivery center.

ShortName of city, town etc.
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
Example<br/><b>General</b>:Erewhon
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Location.address.district
Definition

The name of the administrative area (county).

ShortDistrict name (aka county)
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamesCounty
Example<br/><b>General</b>:Madison
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Location.address.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

ShortSub-unit of country (abbreviations ok)
Control0..1
BindingUnless not suitable, these codes SHALL be taken from USPS Two Letter Alphabetic Codes: Two letter USPS alphabetic codes.
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesProvince, Territory
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Location.address.postalCode
Definition

A postal code designating a region defined by the postal service.

ShortUS Zip Codes
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Alternate NamesZip
Example<br/><b>General</b>:9132
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. Location.address.country
Definition

Country - a nation as commonly understood or generally accepted.

ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. Location.address.period
Definition

Time period when address was/is in use.

ShortTime period when address was/is in use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Requirements

Allows addresses to be placed in historical context.

Example<br/><b>General</b>:&lt;valuePeriod&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;start&nbsp;value=&quot;2010-03-23&quot;/&gt;<br/>&nbsp;&nbsp;&lt;end&nbsp;value=&quot;2010-07-01&quot;/&gt;<br/>&lt;/valuePeriod&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Location.physicalType
Definition

Physical form of the location, e.g. building, room, vehicle, road.

ShortPhysical form of the location
Control0..1
BindingFor example codes, see LocationType: Physical form of the location.
TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

For purposes of showing relevant locations in queries, we need to categorize locations.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. Location.position
Definition

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

ShortThe absolute geographic location
Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

For mobile applications and automated route-finding knowing the exact location of the Location is required.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. Location.position.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
124. Location.position.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
126. Location.position.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
128. Location.position.longitude
Definition

Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).

ShortLongitude with WGS84 datum
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. Location.position.latitude
Definition

Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).

ShortLatitude with WGS84 datum
Control1..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. Location.position.altitude
Definition

Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).

ShortAltitude with WGS84 datum
Control0..1
Typedecimal
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. Location.managingOrganization
Definition

The organization responsible for the provisioning and upkeep of the location.

ShortOrganization responsible for provisioning and upkeep
Comments

This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.

Control0..1
TypeReference(HSDOrganization)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Need to know who manages the location.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. Location.partOf
Definition

Another Location of which this Location is physically a part of.

ShortAnother Location this one is physically a part of
Control0..0
TypeReference(Location)
Is Modifierfalse
Summaryfalse
Requirements

For purposes of location, display and identification, knowing which locations are located within other locations is important.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Location.hoursOfOperation
Definition

What days/times during a week is this location usually open.

ShortWhat days/times during a week is this location usually open
Comments

This type of information is commonly found published in directories and on websites informing customers when the facility is available.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Location.hoursOfOperation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
142. Location.hoursOfOperation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
144. Location.hoursOfOperation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
146. Location.hoursOfOperation.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Shortmon | tue | wed | thu | fri | sat | sun
Control0..*
BindingThe codes SHALL be taken from DaysOfWeek: The days of the week.
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. Location.hoursOfOperation.allDay
Definition

The Location is open all day.

ShortThe Location is open all day
Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. Location.hoursOfOperation.openingTime
Definition

Time that the Location opens.

ShortTime that the Location opens
Control0..1
Typetime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. Location.hoursOfOperation.closingTime
Definition

Time that the Location closes.

ShortTime that the Location closes
Control0..1
Typetime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. Location.availabilityExceptions
Definition

A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.

ShortDescription of availability exceptions
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. Location.endpoint
Definition

Technical endpoints providing access to services operated for the location.

ShortTechnical endpoints providing access to services operated for the location
Control0..*
TypeReference(Endpoint)
Is Modifierfalse
Summaryfalse
Requirements

Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))