Location
Full Profile Definition: | Profile: Healthcare Location |
Resource Content:
Differential
Location | I | Location | There are no (further) constraints on this element Element idLocation Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idLocation.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idLocation.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. 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.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idLocation.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. 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.
|
meta-source | Σ | 1..1 | uri | Element idLocation.meta.source:meta-source uri of the data source DefinitionTypically the data owner's URL followed by a source/file description mandatory for all resources in bWell's FHIR Server 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. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
example of meta.source https://www.icanbwell.com/provider-directory Mappings
|
profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idLocation.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. canonical(StructureDefinition) Constraints
|
meta-security | Σ | 1..* | CodingBinding | Element idLocation.meta.security:meta-security security tags representing the data's owner, vendor, and accessibility Definitiondata owner: data vendor: data access: /owner & /access are mandatory for all resources in bWell's FHIR Server 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. Security Labels from the Healthcare Privacy and Security Classification System.
example of data owner security tag { "system": "https://www.icanbwell.com/owner", "code": "bwell" } example of data access security tag { "system": "https://www.icanbwell.com/access", "code": "bwell" } example of data vendor security tag { "system": "https://www.icanbwell.com/vendor", "code": "bwell" } Mappings
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idLocation.meta.tag Tags applied to this resource DefinitionTags 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. 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. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idLocation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | Element idLocation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) slice by types Constraints
|
location-parking | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-parking Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 1..1 | string | Element idLocation.extension:location-parking.id parking DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-parking.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | Element idLocation.extension:location-parking.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. Needs Review, this value has been set as a client-specific value location-parking
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idLocation.extension:location-parking.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Unordered, Open, by $this(Type) Constraints
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data type | ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueId | id | There are no (further) constraints on this element Data type | ||
valueInstant | instant | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||
valueOid | oid | There are no (further) constraints on this element Data type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | There are no (further) constraints on this element Data type | ||
valueAddress | Address | There are no (further) constraints on this element Data type | ||
valueAge | Age | There are no (further) constraints on this element Data type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||
valueCount | Count | There are no (further) constraints on this element Data type | ||
valueDistance | Distance | There are no (further) constraints on this element Data type | ||
valueDuration | Duration | There are no (further) constraints on this element Data type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueSignature | Signature | There are no (further) constraints on this element Data type | ||
valueTiming | Timing | There are no (further) constraints on this element Data type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data type | ||
valueMeta | Meta | There are no (further) constraints on this element Data type | ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
valueString | 1..1 | string | Element idLocation.extension:location-parking.value[x]:valueString string value of the directions DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
location-image | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-image Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 1..1 | string | Element idLocation.extension:location-image.id photo DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-image.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | Element idLocation.extension:location-image.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. Needs Review, this value has been set as a client-specific value location-image
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idLocation.extension:location-image.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Unordered, Open, by $this(Type) Constraints
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data type | ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueId | id | There are no (further) constraints on this element Data type | ||
valueInstant | instant | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||
valueOid | oid | There are no (further) constraints on this element Data type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | There are no (further) constraints on this element Data type | ||
valueAddress | Address | There are no (further) constraints on this element Data type | ||
valueAge | Age | There are no (further) constraints on this element Data type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||
valueCount | Count | There are no (further) constraints on this element Data type | ||
valueDistance | Distance | There are no (further) constraints on this element Data type | ||
valueDuration | Duration | There are no (further) constraints on this element Data type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueSignature | Signature | There are no (further) constraints on this element Data type | ||
valueTiming | Timing | There are no (further) constraints on this element Data type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data type | ||
valueMeta | Meta | There are no (further) constraints on this element Data type | ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
valueString | 1..1 | string | Element idLocation.extension:location-image.value[x]:valueString link to photo as a string value DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | Element idLocation.identifier a value to identify the resource by DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Unordered, Open, by slice by types Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 1..1 | string | Element idLocation.identifier.id set case-by-case DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
type | Σ | 1..1 | CodeableConceptBinding | Element idLocation.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Needs binding valueset 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | Σ | 1..1 | uri | Element idLocation.identifier.system The system which created the identifier DefinitionValues may be an oid, uri, url, or canonical 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. for mapped data, this is frequently a canonical url
General http://www.acme.com/identifiers/patient a client's unknown system https://www.health.org/person-identifier Mappings
|
value | Σ | 1..1 | string | Element idLocation.identifier.value The unique value DefinitionThe raw identifier value that represents a resource This should be the raw value, as it exists in the source data (ie without prefix) 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idLocation.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idLocation.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
npi | Σ | 0..* | IdentifierPattern | Element idLocation.identifier:npi NPI of a practitioner or organization Definitionnational provider identifier as defined by nppes Organization label locations in registries, need to keep track of those.
{ "id": "npi", "use": "official", "type": { "coding": [ { "id": "type-npi", "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NPI" } ] }, "system": "http://hl7.org/fhir/sid/us-npi" }
|
facility-id | Σ | 1..* | IdentifierPattern | Element idLocation.identifier:facility-id external source id for the location Alternate nameslocation identifier, practice identifier Definitionraw value used by the data source to identify the record system = source URI
{ "id": "facility-id", "type": { "coding": [ { "id": "facility-id", "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "FI" } ] } }
|
status | S Σ ?! | 1..1 | codeBinding | Element idLocation.status active | inactive DefinitionDefault to active when missing or unknown Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use.
|
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatus The operational status of the location (typically only for a bed/room) DefinitionThe 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. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. The operational status if the location (where typically a bed/room).
|
name | S Σ | 1..1 | string | Element idLocation.name name of the facility Alternate namespractice name DefinitionName of the location as used by humans. Does not need to be unique. typically the same as the organization name
|
alias | S | 0..* | string | Element idLocation.alias other names for the location DefinitionA list of alternate names that the location is known as, or was known as, in the past. 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. If more than one name is relevant, list the alternatives here
|
description | S Σ | 0..1 | string | Element idLocation.description description of the location DefinitionDescription of the Location, which helps patients in finding or referencing the place. Humans need additional information to verify a correct location has been identified. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | S Σ | 1..1 | codeBindingFixed Value | Element idLocation.mode Fixed value 'instance' DefinitionIndicates the resourcce represents a specific location. 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. If the record is for a physical location, use instance Indicates whether a resource instance represents a specific location or a class of locations.
instance
|
type | S Σ | 1..* | CodeableConceptBinding | Element idLocation.type Type of function performed DefinitionIndicates the type of function performed at the location Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Unordered, Open, by slice by type Binding Indicates the type of function performed at the location.
|
(All Slices) | There are no (further) constraints on this element | |||
id | 1..1 | string | Element idLocation.type.id set to type code DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idLocation.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
foo { "id": "bar", "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "laboratory" } Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
specialty | Σ | 1..* | CodeableConceptBinding | Element idLocation.type:specialty location specialty DefinitionIndicates the type of function performed at the location. set raw value as code, with code.system representing source URL Indicates the type of function performed at the location.
|
covid-vaccine | Σ | 0..1 | CodeableConceptBinding | Element idLocation.type:covid-vaccine COVID-19 Vaccine Site DefinitionIndicates if a location offers COVID-19 vaccines Needs Review Indicates the type of function performed at the location.
|
covid-test | Σ | 0..1 | CodeableConceptBinding | Element idLocation.type:covid-test COVID-19 Testing Site DefinitionIndicates if a location offers COVID-19 testing Needs Review Indicates the type of function performed at the location.
|
er-indicator | Σ | 0..1 | CodeableConceptBinding | Element idLocation.type:er-indicator ER indicator DefinitionIndicates if a location is an Emergency Room Needs Review Indicates the type of function performed at the location.
|
telecom | S I | 0..* | ContactPoint | Element idLocation.telecom Details of a technology-based contact point Definitionphone, fax, etc Unordered, Open, by slice by types Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 1..1 | string | Element idLocation.telecom.id set to use and type code(s) DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.telecom.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ I | 1..1 | codeBinding | There are no (further) constraints on this element Element idLocation.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
|
value | Σ | 1..1 | string | Element idLocation.telecom.value The value of the contact point DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idLocation.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idLocation.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies 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. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idLocation.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
business-phone | I | 0..* | ContactPointPattern | Element idLocation.telecom:business-phone Contact phone number for the business DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
{ "id": "business-phone", "system": "phone", "use": "work" }
|
business-fax | I | 0..* | ContactPointPattern | Element idLocation.telecom:business-fax Contact fax number for the business DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
{ "id": "business-fax", "system": "fax", "use": "work" }
|
address | S | 0..1 | Address | Element idLocation.address An address expressed using postal conventions DefinitionA physical or postal address If locations can be visited, we need to keep track of their address. Additional addresses should be recorded using another instance of the Location resource, or via the Organization. Unordered, Open, by slice by types Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | S | 1..1 | string | Element idLocation.address.id pattern: use - type - 'current'/period-end in MMDDYYYY format DefinitionA unique identifier for the element within a given resource incoming addresses are presumed current unless otherwise specified id example of a current address home-both-current id example of a previous address home-old-2022 Mappings
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.address.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | S Σ ?! | 0..1 | codeBinding | Element idLocation.address.use home | work | temp | billing DefinitionThe purpose of the address Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address.
General home Mappings
|
type | S Σ | 1..1 | codeBinding | Element idLocation.address.type postal | physical | both (presumed both if absent) DefinitionThe type of an address (physical/postal) 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). The type of an address (physical / postal).
General both Mappings
|
text | S Σ | 1..1 | string | Element idLocation.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 0..* | string | Element idLocation.address.line Street name, number, direction & P.O. Box etc DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. addresses are subjected to a standardization process that may alter these values
General 137 Nowhere Street Mappings
|
city | S Σ | 0..1 | string | Element idLocation.address.city City name Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. addresses are subjected to a standardization process that may alter these values
General Erewhon Mappings
|
district | S Σ | 0..1 | string | Element idLocation.address.district District name (aka county) Alternate namesCounty, county DefinitionThe name of the administrative area (county). addresses are subjected to a standardization process that may alter these values
General Madison Mappings
|
state | S Σ | 0..1 | string | Element idLocation.address.state two-digit state code preferred Alternate namesProvince, Territory DefinitionSub-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). addresses are subjected to a standardization process that may alter these values
|
postalCode | S Σ | 0..1 | string | Element idLocation.address.postalCode zip code Alternate namesZip DefinitionA postal code designating a region defined by the postal service. no current structure preference addresses are subjected to a standardization process that may alter these values
General 9132 Mappings
|
country | Σ | 0..1 | string | Element idLocation.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. addresses are subjected to a standardization process that may alter these values
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idLocation.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
business-address | 0..1 | AddressPattern | Element idLocation.address:business-address Physical location DefinitionPhysical address of the location If locations can be visited, we need to keep track of their address. Helix pipelines uses a service to standardize these fields
{ "id": "work-both-current", "use": "work", "type": "both" }
| |
physicalType | S Σ | 0..1 | CodeableConceptBinding | Element idLocation.physicalType:physicalType Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Physical form of the location
|
position | S | 1..1 | BackboneElement | Element idLocation.position The absolute geographic location DefinitionLongitude and latitude values of the physical location Required to calculate distance for Finding Care
|
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.position.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
managingOrganization | S Σ I | 0..1 | Reference(Profile: Healthcare Organization) | Element idLocation.managingOrganization:managingOrganization Healthcare Organization that manages the location / facility DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. 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. Reference(Profile: Healthcare Organization) Constraints
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idLocation.partOf Another Location this one is physically a part of DefinitionAnother Location of which this Location is physically a part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
hours-of-operation | S | 0..* | BackboneElement | Element idLocation.hoursOfOperation:hours-of-operation hours of operation Definitionhours of operation preferred for provider search 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.
|
id | 1..1 | string | Element idLocation.hoursOfOperation:hours-of-operation.id set to day of week code DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation:hours-of-operation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation:hours-of-operation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
daysOfWeek | 0..* | codeBinding | Element idLocation.hoursOfOperation:hours-of-operation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week.
| |
allDay | 0..1 | boolean | Element idLocation.hoursOfOperation:hours-of-operation.allDay The Location is open all day (boolean) DefinitionThe location is open all day.
| |
openingTime | 0..1 | time | Element idLocation.hoursOfOperation:hours-of-operation.openingTime Time that the location opens DefinitionTime that the Location opens.
| |
closingTime | 0..1 | time | Element idLocation.hoursOfOperation:hours-of-operation.closingTime Time that the location closes DefinitionTime that the Location closes.
| |
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Hybrid
Location | I | Location | There are no (further) constraints on this element Element idLocation Details and position information for a physical place DefinitionDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 1..1 | Meta | There are no (further) constraints on this element Element idLocation.meta Metadata about the resource DefinitionThe 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.meta.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.meta.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idLocation.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. 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.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idLocation.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. 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.
|
meta-source | Σ | 1..1 | uri | Element idLocation.meta.source:meta-source uri of the data source DefinitionTypically the data owner's URL followed by a source/file description mandatory for all resources in bWell's FHIR Server 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. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
example of meta.source https://www.icanbwell.com/provider-directory Mappings
|
profile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idLocation.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. 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. canonical(StructureDefinition) Constraints
|
meta-security | Σ | 1..* | CodingBinding | Element idLocation.meta.security:meta-security security tags representing the data's owner, vendor, and accessibility Definitiondata owner: data vendor: data access: /owner & /access are mandatory for all resources in bWell's FHIR Server 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. Security Labels from the Healthcare Privacy and Security Classification System.
example of data owner security tag { "system": "https://www.icanbwell.com/owner", "code": "bwell" } example of data access security tag { "system": "https://www.icanbwell.com/access", "code": "bwell" } example of data vendor security tag { "system": "https://www.icanbwell.com/vendor", "code": "bwell" } Mappings
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idLocation.meta.tag Tags applied to this resource DefinitionTags 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. 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. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idLocation.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idLocation.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idLocation.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | Element idLocation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) slice by types Constraints
|
location-parking | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-parking Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 1..1 | string | Element idLocation.extension:location-parking.id parking DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-parking.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | Element idLocation.extension:location-parking.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. Needs Review, this value has been set as a client-specific value location-parking
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idLocation.extension:location-parking.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Unordered, Open, by $this(Type) Constraints
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data type | ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueId | id | There are no (further) constraints on this element Data type | ||
valueInstant | instant | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||
valueOid | oid | There are no (further) constraints on this element Data type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | There are no (further) constraints on this element Data type | ||
valueAddress | Address | There are no (further) constraints on this element Data type | ||
valueAge | Age | There are no (further) constraints on this element Data type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||
valueCount | Count | There are no (further) constraints on this element Data type | ||
valueDistance | Distance | There are no (further) constraints on this element Data type | ||
valueDuration | Duration | There are no (further) constraints on this element Data type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueSignature | Signature | There are no (further) constraints on this element Data type | ||
valueTiming | Timing | There are no (further) constraints on this element Data type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data type | ||
valueMeta | Meta | There are no (further) constraints on this element Data type | ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
valueString | 1..1 | string | Element idLocation.extension:location-parking.value[x]:valueString string value of the directions DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
location-image | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-image Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 1..1 | string | Element idLocation.extension:location-image.id photo DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.extension:location-image.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | Element idLocation.extension:location-image.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. Needs Review, this value has been set as a client-specific value location-image
| |
value[x] | 0..1 | There are no (further) constraints on this element Element idLocation.extension:location-image.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). Unordered, Open, by $this(Type) Constraints
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data type | ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueId | id | There are no (further) constraints on this element Data type | ||
valueInstant | instant | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||
valueOid | oid | There are no (further) constraints on this element Data type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | There are no (further) constraints on this element Data type | ||
valueAddress | Address | There are no (further) constraints on this element Data type | ||
valueAge | Age | There are no (further) constraints on this element Data type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||
valueCount | Count | There are no (further) constraints on this element Data type | ||
valueDistance | Distance | There are no (further) constraints on this element Data type | ||
valueDuration | Duration | There are no (further) constraints on this element Data type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueSignature | Signature | There are no (further) constraints on this element Data type | ||
valueTiming | Timing | There are no (further) constraints on this element Data type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data type | ||
valueMeta | Meta | There are no (further) constraints on this element Data type | ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
valueString | 1..1 | string | Element idLocation.extension:location-image.value[x]:valueString link to photo as a string value DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | Element idLocation.identifier a value to identify the resource by DefinitionUnique code or number identifying the location to its users. Organization label locations in registries, need to keep track of those. Unordered, Open, by slice by types Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 1..1 | string | Element idLocation.identifier.id set case-by-case DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idLocation.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
type | Σ | 1..1 | CodeableConceptBinding | Element idLocation.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Needs binding valueset 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | Σ | 1..1 | uri | Element idLocation.identifier.system The system which created the identifier DefinitionValues may be an oid, uri, url, or canonical 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. for mapped data, this is frequently a canonical url
General http://www.acme.com/identifiers/patient a client's unknown system https://www.health.org/person-identifier Mappings
|
value | Σ | 1..1 | string | Element idLocation.identifier.value The unique value DefinitionThe raw identifier value that represents a resource This should be the raw value, as it exists in the source data (ie without prefix) 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idLocation.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idLocation.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
npi | Σ | 0..* | IdentifierPattern | Element idLocation.identifier:npi NPI of a practitioner or organization Definitionnational provider identifier as defined by nppes Organization label locations in registries, need to keep track of those.
{ "id": "npi", "use": "official", "type": { "coding": [ { "id": "type-npi", "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NPI" } ] }, "system": "http://hl7.org/fhir/sid/us-npi" }
|
facility-id | Σ | 1..* | IdentifierPattern | Element idLocation.identifier:facility-id external source id for the location Alternate nameslocation identifier, practice identifier Definitionraw value used by the data source to identify the record system = source URI
{ "id": "facility-id", "type": { "coding": [ { "id": "facility-id", "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "FI" } ] } }
|
status | S Σ ?! | 1..1 | codeBinding | Element idLocation.status active | inactive DefinitionDefault to active when missing or unknown Note that FHIR strings SHALL NOT exceed 1MB in size Indicates whether the location is still in use.
|
operationalStatus | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idLocation.operationalStatus The operational status of the location (typically only for a bed/room) DefinitionThe 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. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. The operational status if the location (where typically a bed/room).
|
name | S Σ | 1..1 | string | Element idLocation.name name of the facility Alternate namespractice name DefinitionName of the location as used by humans. Does not need to be unique. typically the same as the organization name
|
alias | S | 0..* | string | Element idLocation.alias other names for the location DefinitionA list of alternate names that the location is known as, or was known as, in the past. 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. If more than one name is relevant, list the alternatives here
|
description | S Σ | 0..1 | string | Element idLocation.description description of the location DefinitionDescription of the Location, which helps patients in finding or referencing the place. Humans need additional information to verify a correct location has been identified. Note that FHIR strings SHALL NOT exceed 1MB in size
|
mode | S Σ | 1..1 | codeBindingFixed Value | Element idLocation.mode Fixed value 'instance' DefinitionIndicates the resourcce represents a specific location. 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. If the record is for a physical location, use instance Indicates whether a resource instance represents a specific location or a class of locations.
instance
|
type | S Σ | 1..* | CodeableConceptBinding | Element idLocation.type Type of function performed DefinitionIndicates the type of function performed at the location Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Unordered, Open, by slice by type Binding Indicates the type of function performed at the location.
|
(All Slices) | There are no (further) constraints on this element | |||
id | 1..1 | string | Element idLocation.type.id set to type code DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idLocation.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
foo { "id": "bar", "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "laboratory" } Mappings
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idLocation.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
specialty | Σ | 1..* | CodeableConceptBinding | Element idLocation.type:specialty location specialty DefinitionIndicates the type of function performed at the location. set raw value as code, with code.system representing source URL Indicates the type of function performed at the location.
|
covid-vaccine | Σ | 0..1 | CodeableConceptBinding | Element idLocation.type:covid-vaccine COVID-19 Vaccine Site DefinitionIndicates if a location offers COVID-19 vaccines Needs Review Indicates the type of function performed at the location.
|
covid-test | Σ | 0..1 | CodeableConceptBinding | Element idLocation.type:covid-test COVID-19 Testing Site DefinitionIndicates if a location offers COVID-19 testing Needs Review Indicates the type of function performed at the location.
|
er-indicator | Σ | 0..1 | CodeableConceptBinding | Element idLocation.type:er-indicator ER indicator DefinitionIndicates if a location is an Emergency Room Needs Review Indicates the type of function performed at the location.
|
telecom | S I | 0..* | ContactPoint | Element idLocation.telecom Details of a technology-based contact point Definitionphone, fax, etc Unordered, Open, by slice by types Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 1..1 | string | Element idLocation.telecom.id set to use and type code(s) DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.telecom.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ I | 1..1 | codeBinding | There are no (further) constraints on this element Element idLocation.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
|
value | Σ | 1..1 | string | Element idLocation.telecom.value The value of the contact point DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idLocation.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idLocation.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies 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. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idLocation.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
business-phone | I | 0..* | ContactPointPattern | Element idLocation.telecom:business-phone Contact phone number for the business DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
{ "id": "business-phone", "system": "phone", "use": "work" }
|
business-fax | I | 0..* | ContactPointPattern | Element idLocation.telecom:business-fax Contact fax number for the business DefinitionThe contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
{ "id": "business-fax", "system": "fax", "use": "work" }
|
address | S | 0..1 | Address | Element idLocation.address An address expressed using postal conventions DefinitionA physical or postal address If locations can be visited, we need to keep track of their address. Additional addresses should be recorded using another instance of the Location resource, or via the Organization. Unordered, Open, by slice by types Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | S | 1..1 | string | Element idLocation.address.id pattern: use - type - 'current'/period-end in MMDDYYYY format DefinitionA unique identifier for the element within a given resource incoming addresses are presumed current unless otherwise specified id example of a current address home-both-current id example of a previous address home-old-2022 Mappings
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.address.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | S Σ ?! | 0..1 | codeBinding | Element idLocation.address.use home | work | temp | billing DefinitionThe purpose of the address Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address.
General home Mappings
|
type | S Σ | 1..1 | codeBinding | Element idLocation.address.type postal | physical | both (presumed both if absent) DefinitionThe type of an address (physical/postal) 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). The type of an address (physical / postal).
General both Mappings
|
text | S Σ | 1..1 | string | Element idLocation.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label A renderable, unencoded form. 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.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | S Σ | 0..* | string | Element idLocation.address.line Street name, number, direction & P.O. Box etc DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. addresses are subjected to a standardization process that may alter these values
General 137 Nowhere Street Mappings
|
city | S Σ | 0..1 | string | Element idLocation.address.city City name Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. addresses are subjected to a standardization process that may alter these values
General Erewhon Mappings
|
district | S Σ | 0..1 | string | Element idLocation.address.district District name (aka county) Alternate namesCounty, county DefinitionThe name of the administrative area (county). addresses are subjected to a standardization process that may alter these values
General Madison Mappings
|
state | S Σ | 0..1 | string | Element idLocation.address.state two-digit state code preferred Alternate namesProvince, Territory DefinitionSub-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). addresses are subjected to a standardization process that may alter these values
|
postalCode | S Σ | 0..1 | string | Element idLocation.address.postalCode zip code Alternate namesZip DefinitionA postal code designating a region defined by the postal service. no current structure preference addresses are subjected to a standardization process that may alter these values
General 9132 Mappings
|
country | Σ | 0..1 | string | Element idLocation.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. addresses are subjected to a standardization process that may alter these values
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idLocation.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
business-address | 0..1 | AddressPattern | Element idLocation.address:business-address Physical location DefinitionPhysical address of the location If locations can be visited, we need to keep track of their address. Helix pipelines uses a service to standardize these fields
{ "id": "work-both-current", "use": "work", "type": "both" }
| |
physicalType | S Σ | 0..1 | CodeableConceptBinding | Element idLocation.physicalType:physicalType Physical form of the location DefinitionPhysical form of the location, e.g. building, room, vehicle, road. For purposes of showing relevant locations in queries, we need to categorize locations. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Physical form of the location
|
position | S | 1..1 | BackboneElement | Element idLocation.position The absolute geographic location DefinitionLongitude and latitude values of the physical location Required to calculate distance for Finding Care
|
id | 0..1 | string | There are no (further) constraints on this element Element idLocation.position.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.position.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
longitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.longitude Longitude with WGS84 datum DefinitionLongitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
latitude | 1..1 | decimal | There are no (further) constraints on this element Element idLocation.position.latitude Latitude with WGS84 datum DefinitionLatitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
altitude | 0..1 | decimal | There are no (further) constraints on this element Element idLocation.position.altitude Altitude with WGS84 datum DefinitionAltitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below). Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
managingOrganization | S Σ I | 0..1 | Reference(Profile: Healthcare Organization) | Element idLocation.managingOrganization:managingOrganization Healthcare Organization that manages the location / facility DefinitionThe organization responsible for the provisioning and upkeep of the location. Need to know who manages the location. 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. Reference(Profile: Healthcare Organization) Constraints
|
partOf | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idLocation.partOf Another Location this one is physically a part of DefinitionAnother Location of which this Location is physically a part of. For purposes of location, display and identification, knowing which locations are located within other locations is important. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
hours-of-operation | S | 0..* | BackboneElement | Element idLocation.hoursOfOperation:hours-of-operation hours of operation Definitionhours of operation preferred for provider search 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.
|
id | 1..1 | string | Element idLocation.hoursOfOperation:hours-of-operation.id set to day of week code DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation:hours-of-operation.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idLocation.hoursOfOperation:hours-of-operation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
daysOfWeek | 0..* | codeBinding | Element idLocation.hoursOfOperation:hours-of-operation.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week.
| |
allDay | 0..1 | boolean | Element idLocation.hoursOfOperation:hours-of-operation.allDay The Location is open all day (boolean) DefinitionThe location is open all day.
| |
openingTime | 0..1 | time | Element idLocation.hoursOfOperation:hours-of-operation.openingTime Time that the location opens DefinitionTime that the Location opens.
| |
closingTime | 0..1 | time | Element idLocation.hoursOfOperation:hours-of-operation.closingTime Time that the location closes DefinitionTime that the Location closes.
| |
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idLocation.availabilityExceptions Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element idLocation.endpoint Technical endpoints providing access to services operated for the location DefinitionTechnical endpoints providing access to services operated for the location. 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Examples:
TBD