FHIR IG analytics
| Package | nictiz.fhir.nl.r4.nl-core |
| Resource Type | StructureDefinition |
| Id | nl-core-HealthcareProvider.json |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=nictiz.fhir.nl.r4.nl-core@0.12.0-labtrial.1&canonical=http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider |
| URL | http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider |
| Status | draft |
| Name | NlcoreHealthcareProvider |
| Title | nl core HealthcareProvider |
| Realm | nl |
| Description | A healthcare provider is an organization that offers and provides medical, paramedic and/or nursing care to patients/clients. Examples include: hospitals, nursing homes, doctor’s offices. |
| Purpose | A derived profile from [zib-HealthcareProvider](http://nictiz.nl/fhir/StructureDefinition/zib-HealthcareProvider) to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib. |
| Copyright | Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
| Type | Location |
| Kind | resource |
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.
Source1
{
"resourceType": "StructureDefinition",
"id": "nl-core-HealthcareProvider",
"text": {
"status": "empty",
"div": "<!-- snip (see above) -->"
},
"url": "http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider",
"name": "NlcoreHealthcareProvider",
"title": "nl core HealthcareProvider",
"status": "draft",
"publisher": "Nictiz",
"contact": [
{
"name": "Nictiz",
"telecom": [
{
"system": "url",
"value": "https://www.nictiz.nl",
"use": "work"
}
]
}
],
"description": "A healthcare provider is an organization that offers and provides medical, paramedic and/or nursing care to patients/clients. Examples include: hospitals, nursing homes, doctor’s offices.",
"purpose": "A derived profile from [zib-HealthcareProvider](http://nictiz.nl/fhir/StructureDefinition/zib-HealthcareProvider) to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "zib-healthcareprovider-v3.4-2020EN",
"uri": "https://zibs.nl/wiki/HealthcareProvider-v3.4(2020EN)",
"name": "zib HealthcareProvider-v3.4(2020EN)"
},
{
"identity": "zib-contactinformation-v1.2-2020EN",
"uri": "https://zibs.nl/wiki/ContactInformation-v1.2(2020EN)",
"name": "zib ContactInformation-v1.2(2020EN)"
}
],
"kind": "resource",
"abstract": false,
"type": "Location",
"baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/zib-HealthcareProvider",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Location",
"path": "Location",
"short": "HealthcareProvider / OrganizationLocation",
"definition": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.",
"comment": "The zib HealthcareProvider is mapped to this Location profile and a profile on Organization (<http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization>). This Location profile acts as the focal resource of the HealthcareProvider because most references to this zib are concerned about the recording of the physical location where the care to patient/client takes place rather than the organizational information. For the latter, the profile on Organization is used which is referenced using the `managingOrganization` element.\r\n\r\nHealthcare providers usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this HealthcareProvider profile using the `Location.partOf` element to refer to their parent Location. Each instance refers the nl-core-HealthcareProvider-Organization at the appropriate level in the hierarchy. \r\n\r\nIn consultation with 'Registratie aan de Bron', it is agreed to not include the zib concept LocationNumber (NL-CM:17.2.10) due to several reasons. Firstly, its use in the Dutch realm is unclear as this concept was initiated for the Belgium realm with specific requirements. Secondly, it cannot be mapped neatly in the FHIR model which would require the use of an extension. To avoid implementation of specific and not-used FHIR requirements, it is advised to create and use an extension at the use case level where this concept is deemed necessary.",
"alias": [
"OrganisatieLocatie",
"Zorgaanbieder",
"nl-core-HealthcareProvider"
],
"min": 0,
"max": "*",
"base": {
"path": "Location",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": ".Role[classCode=SDLC]"
},
{
"identity": "zib-healthcareprovider-v3.4-2020EN",
"map": "NL-CM:17.2.1",
"comment": "HealthcareProvider"
},
{
"identity": "zib-healthcareprovider-v3.4-2020EN",
"map": "NL-CM:17.2.9",
"comment": "OrganizationLocation"
}
]
},
{
"id": "Location.id",
"path": "Location.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isSummary": true
},
{
"id": "Location.meta",
"path": "Location.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.implicitRules",
"path": "Location.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Location.language",
"path": "Location.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Location.text",
"path": "Location.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Location.contained",
"path": "Location.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.extension",
"path": "Location.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.modifierExtension",
"path": "Location.modifierExtension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.identifier",
"path": "Location.identifier",
"short": "Unique code or number identifying the location to its users",
"definition": "Unique code or number identifying the location to its users.",
"requirements": "Organization label locations in registries, need to keep track of those.",
"min": 0,
"max": "*",
"base": {
"path": "Location.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "rim",
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity": "servd",
"map": "Identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"id": "Location.status",
"path": "Location.status",
"short": "active | suspended | inactive",
"definition": "The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min": 0,
"max": "1",
"base": {
"path": "Location.status",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "LocationStatus"
}
],
"strength": "required",
"description": "Indicates whether the location is still in use.",
"valueSet": "http://hl7.org/fhir/ValueSet/location-status|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"id": "Location.operationalStatus",
"path": "Location.operationalStatus",
"short": "The operational status of the location (typically only for a bed/room)",
"definition": "The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Location.operationalStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "OperationalStatus"
}
],
"strength": "preferred",
"description": "The operational status if the location (where typically a bed/room).",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0116"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity": "rim",
"map": "CV"
},
{
"identity": "orim",
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "Location.name",
"path": "Location.name",
"short": "LocationName",
"definition": "Name of the location.",
"comment": "If the name of a location changes, consider putting the old name in the alias column so that it can still be located through searches.",
"alias": [
"LocatieNaam"
],
"min": 0,
"max": "1",
"base": {
"path": "Location.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".name"
},
{
"identity": "zib-healthcareprovider-v3.4-2020EN",
"map": "NL-CM:17.2.8",
"comment": "LocationName"
}
]
},
{
"id": "Location.alias",
"path": "Location.alias",
"short": "A list of alternate names that the location is known as, or was known as, in the past",
"definition": "A list of alternate names that the location is known as, or was known as, in the past.",
"comment": "There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the location.",
"requirements": "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the location was known by can be very useful.",
"min": 0,
"max": "*",
"base": {
"path": "Location.alias",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".name"
}
]
},
{
"id": "Location.description",
"path": "Location.description",
"short": "Additional details about the location that could be displayed as further information to identify the location beyond its name",
"definition": "Description of the Location, which helps in finding or referencing the place.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements": "Humans need additional information to verify a correct location has been identified.",
"min": 0,
"max": "1",
"base": {
"path": "Location.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".playingEntity[classCode=PLC determinerCode=INSTANCE].desc"
}
]
},
{
"id": "Location.mode",
"path": "Location.mode",
"short": "instance | kind",
"definition": "Indicates whether a resource instance represents a specific location or a class of locations.",
"comment": "This is labeled as a modifier because whether or not the location is a class of locations changes how it can be used and understood.",
"requirements": "When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.",
"min": 0,
"max": "1",
"base": {
"path": "Location.mode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "LocationMode"
}
],
"strength": "required",
"description": "Indicates whether a resource instance represents a specific location or a class of locations.",
"valueSet": "http://hl7.org/fhir/ValueSet/location-mode|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".playingEntity[classCode=PLC].determinerCode"
}
]
},
{
"id": "Location.type",
"path": "Location.type",
"short": "Type of function performed",
"definition": "Indicates the type of function performed at the location.",
"comment": "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.",
"min": 0,
"max": "*",
"base": {
"path": "Location.type",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "LocationType"
}
],
"strength": "extensible",
"description": "Indicates the type of function performed at the location.",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Location.telecom",
"path": "Location.telecom",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "$this"
}
],
"rules": "open"
},
"short": "ContactInformation",
"definition": "The information needed to contact the healthcare organization via telephone and/or e-mail.",
"comment": "The cardinality mismatch between the zib (`0..1`) and FHIR (`0..*`) is explained by the containers TelephoneNumbers (`0..*`) and EmailAddresses (`0..*`) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers.",
"alias": [
"Contactgegevens"
],
"min": 0,
"max": "*",
"base": {
"path": "Location.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "cpt-2",
"severity": "error",
"human": "A system is required if a value is provided.",
"expression": "value.empty() or system.exists()",
"xpath": "not(exists(f:value)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XTN"
},
{
"identity": "rim",
"map": "TEL"
},
{
"identity": "servd",
"map": "ContactPoint"
},
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "zib-healthcareprovider-v3.4-2020EN",
"map": "NL-CM:17.2.6",
"comment": "ContactInformation"
},
{
"identity": "zib-contactinformation-v1.2-2020EN",
"map": "NL-CM:20.6.1",
"comment": "ContactInformation"
}
]
},
{
"id": "Location.telecom:telephoneNumbers",
"path": "Location.telecom",
"sliceName": "telephoneNumbers",
"short": "TelephoneNumbers",
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"comment": "Implementation of the \"TelephoneNumbers\" concept of zib ContactInformation.\r\n\r\nPlease note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the zib uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the zib code will need to be communicated using the ext-CodeSpecification extension.",
"alias": [
"Telefoonnummers",
"nl-core-ContactInformation-TelephoneNumbers"
],
"min": 0,
"max": "*",
"base": {
"path": "Location.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint",
"profile": [
"http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-TelephoneNumbers"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "cpt-2",
"severity": "error",
"human": "A system is required if a value is provided.",
"expression": "value.empty() or system.exists()",
"xpath": "not(exists(f:value)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XTN"
},
{
"identity": "rim",
"map": "TEL"
},
{
"identity": "servd",
"map": "ContactPoint"
},
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "zib-contactinformation-v1.2-2020EN",
"map": "NL-CM:20.6.2",
"comment": "TelephoneNumbers"
}
]
},
{
"id": "Location.telecom:emailAddresses",
"path": "Location.telecom",
"sliceName": "emailAddresses",
"short": "EmailAddresses",
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"comment": "Implementation of the \"EmailAddresses\" concept of zib ContactInformation.",
"alias": [
"EmailAdressen",
"nl-core-ContactInformation-EmailAddresses"
],
"min": 0,
"max": "*",
"base": {
"path": "Location.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint",
"profile": [
"http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-EmailAddresses"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "cpt-2",
"severity": "error",
"human": "A system is required if a value is provided.",
"expression": "value.empty() or system.exists()",
"xpath": "not(exists(f:value)) or exists(f:system)",
"source": "http://hl7.org/fhir/StructureDefinition/ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XTN"
},
{
"identity": "rim",
"map": "TEL"
},
{
"identity": "servd",
"map": "ContactPoint"
},
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "zib-contactinformation-v1.2-2020EN",
"map": "NL-CM:20.6.3",
"comment": "EmailAddresses"
}
]
},
{
"id": "Location.address",
"path": "Location.address",
"short": "AddressInformation",
"definition": "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.",
"comment": "This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the [zib AddressInformation v1.1 (2020)](https://zibs.nl/wiki/AddressInformation-v1.1(2020EN)). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.\r\n\r\nTo have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.\r\n\r\n**Separate address parts**\r\n\r\nThe first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.\r\n\r\n**Custom address types**\r\n\r\nThe second addition is that the zib defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the zib concepts are mapped to the various FHIR elements (see the ConceptMaps <http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse> and <http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType> as well). The code from the zib should also be included using the extension on `Address.extension:addressType`.\r\n\r\n| zib | .ext:addressType | .use | .type |\r\n|-----------------------------------|------------------|------|----------|\r\n| Postal Address/Postadres | PST | | postal |\r\n| Primary Home/Officieel adres | HP | home | both |\r\n| Visit Address/Woon-/verblijfadres | PHYS | home | physical |\r\n| Temporary Address/Tijdelijk adres | TMP | temp | |\r\n| Work Place/Werkadres | WP | work | |\r\n| Vacation Home/Vakantie adres | HV | temp | |\r\n\r\nIf `Address.type` is _both_ then this is to be understood as a dual purpose address (postal and physical), unless a specific _postal_ type address is added. Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.\r\n\r\nNote: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the zib ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.",
"requirements": "If locations can be visited, we need to keep track of their address.",
"alias": [
"Adresgegevens",
"nl-core-AddressInformation"
],
"min": 0,
"max": "1",
"base": {
"path": "Location.address",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Address",
"profile": [
"http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "XAD"
},
{
"identity": "rim",
"map": "AD"
},
{
"identity": "servd",
"map": "Address"
},
{
"identity": "rim",
"map": ".addr"
},
{
"identity": "zib-addressinformation-v1.1-2020EN",
"map": "NL-CM:20.5.1",
"comment": "AddressInformation"
},
{
"identity": "zib-healthcareprovider-v3.4-2020EN",
"map": "NL-CM:17.2.5",
"comment": "AddressInformation"
}
]
},
{
"id": "Location.physicalType",
"path": "Location.physicalType",
"short": "Physical form of the location",
"definition": "Physical form of the location, e.g. building, room, vehicle, road.",
"comment": "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.",
"requirements": "For purposes of showing relevant locations in queries, we need to categorize locations.",
"min": 0,
"max": "1",
"base": {
"path": "Location.physicalType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PhysicalType"
}
],
"strength": "example",
"description": "Physical form of the location.",
"valueSet": "http://hl7.org/fhir/ValueSet/location-physical-type"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".playingEntity [classCode=PLC].code"
}
]
},
{
"id": "Location.position",
"path": "Location.position",
"short": "The absolute geographic location",
"definition": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).",
"requirements": "For mobile applications and automated route-finding knowing the exact location of the Location is required.",
"min": 0,
"max": "1",
"base": {
"path": "Location.position",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"
}
]
},
{
"id": "Location.position.id",
"path": "Location.position.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Location.position.extension",
"path": "Location.position.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.position.modifierExtension",
"path": "Location.position.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.position.longitude",
"path": "Location.position.longitude",
"short": "Longitude with WGS84 datum",
"definition": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).",
"comment": "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)",
"min": 1,
"max": "1",
"base": {
"path": "Location.position.longitude",
"min": 1,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"id": "Location.position.latitude",
"path": "Location.position.latitude",
"short": "Latitude with WGS84 datum",
"definition": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).",
"comment": "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)",
"min": 1,
"max": "1",
"base": {
"path": "Location.position.latitude",
"min": 1,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"id": "Location.position.altitude",
"path": "Location.position.altitude",
"short": "Altitude with WGS84 datum",
"definition": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).",
"comment": "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)",
"min": 0,
"max": "1",
"base": {
"path": "Location.position.altitude",
"min": 0,
"max": "1"
},
"type": [
{
"code": "decimal"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"id": "Location.managingOrganization",
"path": "Location.managingOrganization",
"short": "Organization responsible for provisioning and upkeep",
"definition": "The organization responsible for the provisioning and upkeep of the location.",
"comment": "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.",
"requirements": "Need to know who manages the location.",
"min": 0,
"max": "1",
"base": {
"path": "Location.managingOrganization",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "rim",
"map": ".scopingEntity[classCode=ORG determinerKind=INSTANCE]"
}
]
},
{
"id": "Location.partOf",
"path": "Location.partOf",
"short": "Another Location this one is physically a part of",
"definition": "Another Location of which this Location is physically a part of.",
"comment": "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.",
"requirements": "For purposes of location, display and identification, knowing which locations are located within other locations is important.",
"min": 0,
"max": "1",
"base": {
"path": "Location.partOf",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Location",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "rim",
"map": ".inboundLink[typeCode=PART].source[classCode=SDLC]"
}
]
},
{
"id": "Location.hoursOfOperation",
"path": "Location.hoursOfOperation",
"short": "What days/times during a week is this location usually open",
"definition": "What days/times during a week is this location usually open.",
"comment": "This type of information is commonly found published in directories and on websites informing customers when the facility is available.\n\nSpecific services within the location may have their own hours which could be shorter (or longer) than the locations hours.",
"min": 0,
"max": "*",
"base": {
"path": "Location.hoursOfOperation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "Location.hoursOfOperation.id",
"path": "Location.hoursOfOperation.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Location.hoursOfOperation.extension",
"path": "Location.hoursOfOperation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.hoursOfOperation.modifierExtension",
"path": "Location.hoursOfOperation.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Location.hoursOfOperation.daysOfWeek",
"path": "Location.hoursOfOperation.daysOfWeek",
"short": "mon | tue | wed | thu | fri | sat | sun",
"definition": "Indicates which days of the week are available between the start and end Times.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min": 0,
"max": "*",
"base": {
"path": "Location.hoursOfOperation.daysOfWeek",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DaysOfWeek"
}
],
"strength": "required",
"description": "The days of the week.",
"valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "Location.hoursOfOperation.allDay",
"path": "Location.hoursOfOperation.allDay",
"short": "The Location is open all day",
"definition": "The Location is open all day.",
"min": 0,
"max": "1",
"base": {
"path": "Location.hoursOfOperation.allDay",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "Location.hoursOfOperation.openingTime",
"path": "Location.hoursOfOperation.openingTime",
"short": "Time that the Location opens",
"definition": "Time that the Location opens.",
"min": 0,
"max": "1",
"base": {
"path": "Location.hoursOfOperation.openingTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "time"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "Location.hoursOfOperation.closingTime",
"path": "Location.hoursOfOperation.closingTime",
"short": "Time that the Location closes",
"definition": "Time that the Location closes.",
"min": 0,
"max": "1",
"base": {
"path": "Location.hoursOfOperation.closingTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "time"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "Location.availabilityExceptions",
"path": "Location.availabilityExceptions",
"short": "Description of availability exceptions",
"definition": "A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min": 0,
"max": "1",
"base": {
"path": "Location.availabilityExceptions",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Location.endpoint",
"path": "Location.endpoint",
"short": "Technical endpoints providing access to services operated for the location",
"definition": "Technical endpoints providing access to services operated for the location.",
"comment": "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.",
"requirements": "Organizations may have different systems at different locations that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min": 0,
"max": "*",
"base": {
"path": "Location.endpoint",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Location",
"path": "Location",
"comment": "The zib HealthcareProvider is mapped to this Location profile and a profile on Organization (<http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization>). This Location profile acts as the focal resource of the HealthcareProvider because most references to this zib are concerned about the recording of the physical location where the care to patient/client takes place rather than the organizational information. For the latter, the profile on Organization is used which is referenced using the `managingOrganization` element.\r\n\r\nHealthcare providers usually consist of multiple organizational levels and physical locations. The hierarchical structure may be captured by using multiple instances of this HealthcareProvider profile using the `Location.partOf` element to refer to their parent Location. Each instance refers the nl-core-HealthcareProvider-Organization at the appropriate level in the hierarchy. \r\n\r\nIn consultation with 'Registratie aan de Bron', it is agreed to not include the zib concept LocationNumber (NL-CM:17.2.10) due to several reasons. Firstly, its use in the Dutch realm is unclear as this concept was initiated for the Belgium realm with specific requirements. Secondly, it cannot be mapped neatly in the FHIR model which would require the use of an extension. To avoid implementation of specific and not-used FHIR requirements, it is advised to create and use an extension at the use case level where this concept is deemed necessary.",
"alias": [
"nl-core-HealthcareProvider"
]
},
{
"id": "Location.telecom:telephoneNumbers",
"path": "Location.telecom",
"sliceName": "telephoneNumbers",
"type": [
{
"code": "ContactPoint",
"profile": [
"http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-TelephoneNumbers"
]
}
]
},
{
"id": "Location.telecom:emailAddresses",
"path": "Location.telecom",
"sliceName": "emailAddresses",
"type": [
{
"code": "ContactPoint",
"profile": [
"http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-EmailAddresses"
]
}
]
},
{
"id": "Location.address",
"path": "Location.address",
"type": [
{
"code": "Address",
"profile": [
"http://nictiz.nl/fhir/StructureDefinition/nl-core-AddressInformation"
]
}
]
},
{
"id": "Location.managingOrganization",
"path": "Location.managingOrganization",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization"
]
}
]
},
{
"id": "Location.partOf",
"path": "Location.partOf",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Location",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider"
]
}
]
}
]
}
}
FHIR
FHIRsmith