| PathPatient (Patient) | C | | NlcorePatient | Element idPatient Short descriptionPatient Alternate namesSubjectOfCare Client Resident, Patient, nl-core-Patient DefinitionThe person whose human tissue is analyzed in a pathology study.
NlcorePatient Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
Mappings- rim: Entity. Role, or Act
- rim: Patient[classCode=PAT]
- cda: ClinicalDocument.recordTarget.patientRole
- zib-patient-v3.2-2020EN: NL-CM:0.1.1
|
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Short descriptionLogical 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.
string |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Short descriptionMetadata 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.
Meta ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules Short descriptionA 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.
uri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Short descriptionLanguage 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).
code BindingCommonLanguages (preferred) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Short descriptionText 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.
Narrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Short descriptionContained, 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.
Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| nationality | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPatient.extension:nationality Short descriptionNationality Alternate namesextensions, user content DefinitionThe nationality of the patient.
Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the zib cardinality of 0..1.
Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-nationality ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:nationality.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:nationality.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| code | C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:code Short descriptionNationality Code Alternate namesextensions, user content DefinitionCode representing nationality of patient.
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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:code.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:code.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:code.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuecode Mappings |
| value[x] | | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:code.value[x] Short descriptionNationality Alternate namesNationaliteit DefinitionIndicates the country of citizenship.
NationaliteitCodelijst (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-nationality-v3.0-2020EN: NL-CM:7.6.3
|
| valueCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| period | C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:period Short descriptionNationality Period Alternate namesextensions, user content DefinitionPeriod when nationality was effective.
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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:period.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:period.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:period.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valueperiod Mappings |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idPatient.extension:nationality.extension:period.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| valuePeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:nationality.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/patient-nationality Mappings |
| value[x] | | 0..0 | | There are no (further) constraints on this element Element idPatient.extension:nationality.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| birthPlace | C | 0..1 | Extension(Address) | Element idPatient.extension:birthPlace Short descriptionPlace of Birth for patient Alternate namesextensions, user content DefinitionThe registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.
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.
Extension(Address) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-birthPlace ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:birthPlace.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:birthPlace.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/patient-birthPlace Mappings |
| value[x] | | 1..1 | Address | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Address ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].use Short descriptionhome | work | temp | old | billing - purpose of this address DefinitionThe purpose of this 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.
code BindingAddressUse (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
Generalhome Mappings- rim: n/a
- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].type Short descriptionpostal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
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).
code BindingThe type of an address (physical / postal).
AddressType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
Generalboth Mappings- rim: n/a
- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].text Short descriptionText representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
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.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
General137 Nowhere Street, Erewhon 9132 Mappings- rim: n/a
- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
| line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].line Short descriptionStreet 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.
Note that FHIR strings SHALL NOT exceed 1MB in size
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
General137 Nowhere Street Mappings- rim: n/a
- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
|
| city | Σ | 0..1 | string | Element idPatient.extension:birthPlace.value[x].city Short descriptionBirthPlace Alternate namesMunicpality, Geboorteplaats DefinitionCommentsThe place of birth is part of the CIS personalia as delivered by the CIS-GBA.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
GeneralErewhon Mappings- rim: n/a
- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
- mercurius-core-dataset-2-0: mercurius-core-rubriek-14
|
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].district Short descriptionDistrict name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county).
District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
GeneralMadison Mappings- rim: n/a
- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
| state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].state Short descriptionSub-unit of country (abbreviations ok) 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).
Note that FHIR strings SHALL NOT exceed 1MB in size
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
| postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].postalCode Short descriptionPostal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service.
Note that FHIR strings SHALL NOT exceed 1MB in size
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
General9132 Mappings- rim: n/a
- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
|
| country | Σ | 0..1 | string | Element idPatient.extension:birthPlace.value[x].country Short descriptionBirthCountry Alternate namesGeboorteland DefinitionCommentsISO 3166 3 letter codes can be used in place of a human readable country name.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
- mercurius-core-dataset-2-0: mercurius-core-rubriek-15
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.extension:birthPlace.value[x].period Short descriptionTime 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.
Period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples
General{
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Short descriptionExtensions 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier Short descriptionPatientIdentificationNumber Alternate namesIdentificatienummer DefinitionThe patient’s identification number. In transfer situations, use of the social security number (BSN) must comply with the Use of Social Security Numbers in Healthcare Act (Wbsn-z). In other situations, other number systems can be used, such as internal hospital patient numbers for example.
Patients are almost always assigned specific numerical identifiers.
Identifier SlicingUnordered, Open, by $this(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: 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]
- servd: Identifier
- w5: FiveWs.identifier
- v2: PID-3
- rim: id
- cda: .id
- zib-patient-v3.2-2020EN: NL-CM:0.1.7
|
| bsn | Σ | 0..* | IdentifierPattern | There are no (further) constraints on this element Element idPatient.identifier:bsn Short descriptionAn identifier for this patient DefinitionAn identifier for this patient.
Patients are almost always assigned specific numerical identifiers.
Identifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Pattern{
"system": "http://fhir.nl/fhir/NamingSystem/bsn"
}Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: 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]
- servd: Identifier
- w5: FiveWs.identifier
- v2: PID-3
- rim: id
- cda: .id
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.active Short descriptionWhether this patient's record is in active use DefinitionWhether this patient record is in active use.
Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.
It is often used to filter patient lists to exclude inactive patients
Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
Need to be able to mark a patient record as not to be used because it was created in error.
If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
This resource is generally assumed to be active if no value is provided for the active element
boolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- w5: FiveWs.status
- rim: statusCode
- cda: n/a
|
| name | Σ | 1..* | HumanName | There are no (further) constraints on this element Element idPatient.name Short descriptionNameInformation / PayerName Alternate namesNaamgegevens, BetalerNaam DefinitionRequirementsNeed to be able to track the patient by multiple names. Examples are your official name and a partner name.
A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
HumanName SlicingUnordered, Open, by use(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN
- rim: EN (actually, PN)
- servd: ProviderName
- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
- zib-patient-v3.2-2020EN: NL-CM:0.1.6
- zib-payer-v3.1.1-2020EN: NL-CM:1.1.5
|
| nameInformation | Σ C | 1..1 | NlcoreNameInformation | Element idPatient.name:nameInformation Short descriptionName Alternate namesNaamgegevens, nl-core-NameInformation, Naam DefinitionRequirementsNeed to be able to track the patient by multiple names. Examples are your official name and a partner name.
This .name element accomodates the official parts of a Dutch name according to common international usage and optionally to the zib NameInformation v1.1 (2020). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on .family and on .extension:nameUsage for more information.
Systems that need to work in a Dutch context SHOULD support the extensions as specified in .given, .family and .extension:nameUsage. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that:
- If parts of the name are specified using one or more of the structured elements, the
.text element SHOULD be populated with a rendered version of the full name.
- If parts of the family name are specified using the extensions in
.family, the .family element SHOULD be populated with the full family name.
Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on .given on how to map the FirstNames and Initials concepts, and on .prefix/.suffix on how to map the Titles concept.
Note 2: This element should only contain a person's official names. The GivenName concept is represented in another .name element with .name.use = usual.
Note 3: The examples illustrate how the zib is mapped to FHIR.
NlcoreNameInformation ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() - zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() - nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
(family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
Mappings- rim: n/a
- v2: XPN
- rim: EN (actually, PN)
- servd: ProviderName
- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.1
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| nameUsage | C | 0..1 | Extension(code) | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage Short descriptionPreferred display order of name parts Alternate namesextensions, user content DefinitionA code that represents the preferred display order of the components of this human name.
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.
Extension(code) Extension URLhttp://hl7.org/fhir/StructureDefinition/humanname-assembly-order ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/humanname-assembly-order Mappings |
| value[x] | | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.value[x] Short descriptionNameUsage Alternate namesNaamgebruik DefinitionThis concept indicates the last name or order of last names with which the person is to be addressed.
Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
HumanNameAssemblyOrder (required) Permitted Values NaamgebruikCodelijst_to_HumanNameAssemblyOrder ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.7
|
| valueCode | | | code | There are no (further) constraints on this element Data typecode |
| use | Σ ?! | 1..1 | codeBindingPattern | There are no (further) constraints on this element Element idPatient.name:nameInformation.use Short descriptionusual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name.
Allows the appropriate name for a particular context of use to be selected from among a set of names.
Applications can assume that a name is current unless it explicitly says that it is temporary or old.
code BindingNameUse (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Patternofficial Mappings- rim: n/a
- v2: XPN.7, but often indicated by which field contains the name
- rim: unique(./use)
- servd: ./NamePurpose
|
| text | Σ C | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.text Short descriptionText representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
A renderable, unencoded form.
A representation of the full name, including given names and the family name.
When implementing zib NameInformation, this representation should include the FirstNames or Initials and the family name constructed according to the NameUsage concept.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, nl-core-NameInformation-01 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: implied by XPN.11
- rim: ./formatted
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.4
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.5
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.7
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.11
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.10
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.9
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.8
|
| family | Σ C | 1..1 | string | Element idPatient.name:nameInformation.family Short descriptionFamilyName Alternate namessurname, Geslachtsnaam DefinitionFamily name of the patient.
When implementing zib NameInformation, this representation should be constrcuted from the Prefix, LastName, PartnerPrefix and/or PartnerLastName concepts according to the NameUsage concept.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, nl-core-NameInformation-01 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - nl-core-NameInformation-02: If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
(extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
Mappings- rim: n/a
- v2: XPN.1/FN.1
- rim: ./part[partType = FAM]
- servd: ./FamilyName
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.7
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.11
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.10
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.9
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.8
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.id Short descriptionUnique 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.
string Mappings |
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| prefix | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix Short descriptionVoorvoegsel derived from person's own surname Alternate namesextensions, user content DefinitionThe prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/humanname-own-prefix ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- v2: FN.2
- rim: ENXP where Qualifiers = (VV, R)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-prefix Mappings |
| value[x] | | 1..1 | | Element idPatient.name:nameInformation.family.extension:prefix.value[x] Short descriptionPrefix Alternate namesVoorvoegsels DefinitionPrefix to the last name of the patient.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.11
- mercurius-core-dataset-2-0: mercurius-core-rubriek-6
- mercurius-core-dataset-2-0: mercurius-core-rubriek-8
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| lastName | C | 1..1 | Extension(string) | Element idPatient.name:nameInformation.family.extension:lastName Short descriptionPortion derived from person's own surname Alternate namesextensions, user content DefinitionThe portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.
If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/humanname-own-name ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- v2: FN.3
- rim: ENXP where Qualifiers = (BR)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/humanname-own-name Mappings |
| value[x] | | 1..1 | | Element idPatient.name:nameInformation.family.extension:lastName.value[x] Short descriptionLastName Alternate namesAchternaam DefinitionLast name of the patient.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.10
- mercurius-core-dataset-2-0: mercurius-core-rubriek-5
- mercurius-core-dataset-2-0: mercurius-core-rubriek-7
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| partnerPrefix | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix Short descriptionVoorvoegsel derived from person's partner's surname Alternate namesextensions, user content DefinitionThe prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own.
An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component.
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/humanname-partner-prefix ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- v2: FN.4
- rim: ENXP where Qualifiers = (VV, SP)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Mappings |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.value[x] Short descriptionPartnerPrefix Alternate namesVoorvoegselsPartner DefinitionPrefix to the partner’s last name.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.9
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| partnerLastName | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName Short descriptionPortion derived from person's partner's surname Alternate namesextensions, user content DefinitionThe portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.
If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/humanname-partner-name ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- v2: FN.5
- rim: ENXP where Qualifiers = (SP)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/humanname-partner-name Mappings |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.value[x] Short descriptionPartnerLastName Alternate namesAchternaamPartner DefinitionPartner’s official last name.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.8
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
System.String Maximum string length1048576 |
| given | Σ C | 1..* | string | Element idPatient.name:nameInformation.given Short descriptionInitials Alternate namesfirst name, middle name, Voornaam, Initiaal, Voorletters DefinitionInitials of the patient in capitals, divided by dots.
This element can be used to represent full given names or initials. extension:givenOrInitial SHALL be used on each repretition to specifiy if it's a full name (BR) or an initial (IN).
Zib compatibility
Tthis element is used to represent the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately.
Therefore, the zib concepts are implemented here in the following way:
- Systems SHOULD use a
.given element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR).
- Each of these elements:
- SHOULD be populated with the complete name if it is known, or with the initial if no more information is available.
- As noted, it SHALL be augmented with
extension:givenOrInitial.
Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed.
If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional .name instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance.
Note 1: The GivenName concept should not be included here but in a separate .name instance where .use = usual.
Note 2: As specified by FHIR, multiple official first names MAY be combined in a single .given element (separated by spaces), as long as the .given elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, nl-core-NameInformation-01 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN.2 + XPN.3
- rim: ./part[partType = GIV]
- servd: ./GivenNames
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.4
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.5
- mercurius-core-dataset-2-0: mercurius-core-rubriek-9
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.id Short descriptionUnique 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.
string Mappings |
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| givenOrInitial | C | 1..* | Extension(code) | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.extension:givenOrInitial Short descriptionLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
Used to indicate additional information about the name part and how it should be used.
Extension(code) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- rim: ENXP.qualifier
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.extension:givenOrInitial.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.extension:givenOrInitial.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.extension:givenOrInitial.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Mappings |
| value[x] | | 1..1 | BindingPattern | Element idPatient.name:nameInformation.given.extension:givenOrInitial.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.
EntityNamePartQualifier (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
PatternIN Mappings |
| valueCode | | | code | There are no (further) constraints on this element Data typecode |
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
System.String Maximum string length1048576 |
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.prefix Short descriptionTitles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles.
The zib concept 'titles' is mapped to elements HumanName.prefix and HumanName.suffix. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way.
Export:
Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes.
If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information.
Import:
Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN.5
- rim: ./part[partType = PFX]
- servd: ./TitleCode
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.12
|
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.suffix Short descriptionTitles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles.
The zib concept 'titles' is mapped to elements HumanName.prefix and HumanName.suffix. Semantically this mapping is not complete: the zib uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way.
Export:
Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes.
If it is not possible to breakup the zib concept titles to positioned prefixes and suffixes, the prefix element is used to store all information.
Import:
Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN/4
- rim: ./part[partType = SFX]
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.12
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name:nameInformation.period Short descriptionTime period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person.
Allows names 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.
Period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XPN.13 + XPN.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| nameInformation-GivenName | Σ | 0..* | NlcoreNameInformationGivenName | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName Short descriptionName of a human - parts and usage Alternate namesnl-core-NameInformation.GivenName DefinitionThis slice represents the name information normally used to address the person.
Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
This .name element represents the Dutch given name ("roepnaam") according to the zib NameInformation v1.1 (2020).
Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other .name elements with .name.use = official.
Note 2: The examples illustrate how the zib is mapped to FHIR.
NlcoreNameInformationGivenName ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN
- rim: EN (actually, PN)
- servd: ProviderName
- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
|
| telecom | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom Short descriptionContactInformation Alternate namesContactgegevens DefinitionPatient’s telephone number(s) or e-mail address(es).
People have (primary) ways to contact them in some way such as phone, email.
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.
ContactPoint SlicingUnordered, Open, by $this(Profile) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: PID-13, PID-14, PID-40
- rim: telecom
- cda: .telecom
- zib-patient-v3.2-2020EN: NL-CM:0.1.5
- zib-contactinformation-v1.2-2020EN: NL-CM:20.6.1
- zib-payer-v3.1.1-2020EN: NL-CM:1.1.12
|
| telephoneNumbers | Σ C | 0..* | NlcoreContactInformationTelephoneNumbers | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers Short descriptionTelephoneNumbers Alternate namesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
People have (primary) ways to contact them in some way such as phone, email.
Implementation of the "TelephoneNumbers" concept of zib ContactInformation.
Please 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.
NlcoreContactInformationTelephoneNumbers ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: PID-13, PID-14, PID-40
- rim: telecom
- cda: .telecom
- zib-contactinformation-v1.2-2020EN: NL-CM:20.6.2
|
| emailAddresses | Σ C | 0..* | NlcoreContactInformationEmailAddresses | There are no (further) constraints on this element Element idPatient.telecom:emailAddresses Short descriptionEmailAddresses Alternate namesEmailAdressen, nl-core-ContactInformation-EmailAddresses DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
People have (primary) ways to contact them in some way such as phone, email.
Implementation of the "EmailAddresses" concept of zib ContactInformation.
NlcoreContactInformationEmailAddresses ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: PID-13, PID-14, PID-40
- rim: telecom
- cda: .telecom
- zib-contactinformation-v1.2-2020EN: NL-CM:20.6.3
|
| gender | Σ | 1..1 | codeBinding | Element idPatient.gender Short descriptionGender Alternate namesGeslacht DefinitionRequirementsNeeded for identification of the individual, in combination with (at least) name and birth date.
The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.
code BindingUse ConceptMap MercuriusGender-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
AdministrativeGender (required) Permitted Values MercuriusGender_to_AdministrativeGender ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-8
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: .patient.administrativeGenderCode
- zib-patient-v3.2-2020EN: NL-CM:0.1.9
- mercurius-core-dataset-2-0: mercurius-core-rubriek-10
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.gender.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.gender.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| genderCodelist | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
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.
Extension(CodeableConcept) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification Mappings |
| value[x] | | 0..1 | Binding | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.value[x] Short descriptionGender Alternate namesGeslacht DefinitionPatient’s administrative gender.
GeslachtCodelijst (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-patient-v3.2-2020EN: NL-CM:0.1.9
|
| valueCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.gender.value Short descriptionPrimitive value for code DefinitionData typeSystem.String Maximum string length1048576 |
| birthDate | Σ | 1..1 | date | Element idPatient.birthDate Short descriptionBirthDate Alternate namesGeboortedatum DefinitionRequirementsAge of the individual drives many clinical processes.
If the birth date (i.e. geboortedatum, mercurius-core-rubriek-11) retrieved from Mercurius has the form YY-MM-DD, the birth century (i.e. geboorteeeuw, mercurius-core-rubriek-13) SHALL be used to convert this date to a valid FHIR date of the form YYYY-MM-DD.
date ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-7
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
- cda: .patient.birthTime
- loinc: 21112-8
- zib-patient-v3.2-2020EN: NL-CM:0.1.10
- mercurius-core-dataset-2-0: mercurius-core-rubriek-11
- mercurius-core-dataset-2-0: mercurius-core-rubriek-13
|
| deceased[x] | Σ ?! | 0..1 | | There are no (further) constraints on this element Element idPatient.deceased[x] Short descriptionIndicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not.
The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
Unordered, Open, by $this(Type) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
|
| deceasedBoolean | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.deceased[x]:deceasedBoolean Short descriptionDeathIndicator Alternate namesOverlijdensIndicator DefinitionAn indication stating whether the patient has died.
The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
boolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
- zib-patient-v3.2-2020EN: NL-CM:0.1.32
|
| deceasedDateTime | Σ ?! | 0..1 | dateTime | There are no (further) constraints on this element Element idPatient.deceased[x]:deceasedDateTime Short descriptionDateOfDeath Alternate namesDatumOverlijden, OverlijdensIndicator DefinitionThe date on which the patient died. A ‘vague’ date, such as only the year, is permitted.
The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
The zib recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true.
dateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
- zib-patient-v3.2-2020EN: NL-CM:0.1.33
- zib-patient-v3.2-2020EN: NL-CM:0.1.32
|
| address | Σ | 0..1 | NlcoreAddressInformation | There are no (further) constraints on this element Element idPatient.address Short descriptionAddressInformation Alternate namesAdresgegevens, nl-core-AddressInformation DefinitionAn 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.
May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
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). 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.
To 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.
Separate address parts
The 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.
Custom address types
The 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.
| zib |
.ext:addressType |
.use |
.type |
| Postal Address/Postadres |
PST |
|
postal |
| Primary Home/Officieel adres |
HP |
home |
both |
| Visit Address/Woon-/verblijfadres |
PHYS |
home |
physical |
| Temporary Address/Tijdelijk adres |
TMP |
temp |
|
| Work Place/Werkadres |
WP |
work |
|
| Vacation Home/Vakantie adres |
HV |
temp |
|
If 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.
Note: 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.
NlcoreAddressInformation ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
- v2: PID-11
- rim: addr
- cda: .addr
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.1
- zib-patient-v3.2-2020EN: NL-CM:0.1.4
- zib-payer-v3.1.1-2020EN: NL-CM:1.1.17
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| addressType | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.address.extension:addressType Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
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.
Extension(CodeableConcept) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.use Short descriptionAddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing 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.
code BindingUse ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
AddressUse (required) Permitted Values AdresSoortCodelijst_to_AddressUse ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
Generalhome Mappings- rim: n/a
- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.8
|
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.type Short descriptionAddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address.
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).
code BindingUse ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
AddressType (required) Permitted Values AdresSoortCodelijst_to_AddressType ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
Generalboth Mappings- rim: n/a
- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.8
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.text Short descriptionText representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
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.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
General137 Nowhere Street, Erewhon 9132 Mappings- rim: n/a
- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
| line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.address.line Short descriptionStreet 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.
The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in.
The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the Address.line to which they are attached. The value of Address.line should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]".
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
General137 Nowhere Street Mappings- rim: n/a
- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| streetName | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName Short descriptionstreetName Alternate namesextensions, user content DefinitionCommentsThere 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.
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- rim: ADXP[partType=STR]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Mappings |
| value[x] | | 1..1 | | Element idPatient.address.line.extension:streetName.value[x] Short descriptionStreet Alternate namesStraat DefinitionStreet name of the address.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.2
- mercurius-core-dataset-2-0: mercurius-core-rubriek-16
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| houseNumber | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber Short descriptionhouseNumber Alternate namesextensions, user content DefinitionThe number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.
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.
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- rim: ADXP[partType=BNR]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Mappings |
| value[x] | | 1..1 | | Element idPatient.address.line.extension:houseNumber.value[x] Short descriptionHouseNumber Alternate namesHuisnummer DefinitionHouse number of the address.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.12
- mercurius-core-dataset-2-0: mercurius-core-rubriek-17
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| houseNumberLetter-houseNumberAddition | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition Short descriptionbuildingNumberSuffix Alternate namesextensions, user content DefinitionAny alphabetic character, fraction or other text that may appear after the numeric portion of a building number.
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.
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- rim: ADXP[partType=BNS]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix Mappings |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] Short descriptionHouseNumberLetter / HouseNumberAddition Alternate namesHuisnummerletter, Huisnummertoevoeging DefinitionExport:
- If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition.
- If only a HouseNumberLetter is known, send just that. No trailing space is required.
- If only a HouseNumberAddition is known, communicate that with a leading space.
Import
- If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter.
- If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition.
Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.11
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.10
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| houseNumberIndication | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication Short descriptionadditionalLocator Alternate namesextensions, user content DefinitionThis can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).
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.
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- rim: ADXP[partType=ADL]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Mappings |
| value[x] | C | 1..1 | | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.value[x] Short descriptionHouseNumberIndication Alternate namesAanduidingBijNummer DefinitionThe indication used for addresses which do not consist of the usual street name and house number.
The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. As a result of this, the coded zib HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - houseNumberIndication: Must have value 'by' or 'to'
$this in ('by' | 'to')
Mappings- rim: n/a
- rim: N/A
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.9
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| additionalInformation | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation Short descriptionunitID Alternate namesextensions, user content DefinitionThe number or name of a specific unit contained within a building or complex, as assigned by that building or complex.
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.
Extension(string) Extension URLhttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- rim: ADXP[partType=UNID]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID Mappings |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.value[x] Short descriptionAdditionalInformation Alternate namesAdditioneleInformatie DefinitionExtra information such as the building name, building number, entrance, route number.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.7
|
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address.line.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
System.String Maximum string length1048576 |
| city | Σ | 0..1 | string | Element idPatient.address.city Short descriptionCity Alternate namesMunicpality, Woonplaats DefinitionCommentsNote that FHIR strings SHALL NOT exceed 1MB in size
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
GeneralErewhon Mappings- rim: n/a
- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.3
- mercurius-core-dataset-2-0: mercurius-core-rubriek-19
|
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.district Short descriptionMunicipality Alternate namesCounty, Gemeente DefinitionMunicipality of residence. For Dutch municipalities, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14).
District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
GeneralMadison Mappings- rim: n/a
- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.4
|
| state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.state Short descriptionSub-unit of country (abbreviations ok) 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).
Note that FHIR strings SHALL NOT exceed 1MB in size
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
| postalCode | Σ | 0..1 | string | Element idPatient.address.postalCode Short descriptionPostalCode Alternate namesZip, Postcode DefinitionPostal code, either Dutch or foreign.
Dutch postal codes contain 4 numerical characters, a space and 2 letters in uppercase (nnnn AA). Codes attain values between 1000 and 9999. If the postal code is unknown, the dummy 0000 XX is used in Mercurius.
Foreign postal codes are expressed in free text. If the postal code is unknown, the dummy 0009 XX is used in Mercurius.
If the PostalCode concept (i.e. either postcode, mercurius-core-rubriek-18, or postcodebuitenland, mercurius-core-rubriek-20) attains one of the dummy values indicated above, the .address.postalCode element SHALL be omitted.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples
General9132 Mappings- rim: n/a
- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.6
- mercurius-core-dataset-2-0: mercurius-core-rubriek-18
- mercurius-core-dataset-2-0: mercurius-core-rubriek-20
|
| country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country Short descriptionCountry (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted.
The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the ext-CodeSpecification extension under Address.country.extension:countryCode.
string ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.country.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| countryCode | C | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.address.country.extension:countryCode Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
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.
Extension(CodeableConcept) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country.extension:countryCode.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.country.extension:countryCode.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.country.extension:countryCode.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification Mappings |
| value[x] | | 0..1 | Binding | There are no (further) constraints on this element Element idPatient.address.country.extension:countryCode.value[x] Short descriptionCountry Alternate namesLand DefinitionCountry in which the address is located.
LandCodelijsten (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.5
|
| valueCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address.country.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
System.String Maximum string length1048576 |
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.period Short descriptionTime 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.
Period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples
General{
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| maritalStatus | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Short descriptionMaritalStatus Alternate namesBurgerlijkeStaat DefinitionA person’s marital status according to the terms and definition in the Dutch civil code.
Most, if not all systems capture it.
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.
CodeableConcept BindingBurgerlijkeStaatCodelijst
BurgerlijkeStaatCodelijst (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PID-16
- rim: player[classCode=PSN]/maritalStatusCode
- cda: .patient.maritalStatusCode
- zib-maritalstatus-v3.1-2020EN: NL-CM:7.9.2
|
| multipleBirth[x] | | 0..1 | | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Short descriptionWhether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).
Unordered, Open, by $this(Type) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-24 (bool), PID-25 (integer)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
- cda: n/a
|
| multipleBirthInteger | | | integer | There are no (further) constraints on this element Data typeinteger |
| multipleBirthBoolean | | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.multipleBirth[x]:multipleBirthBoolean Short descriptionMultipleBirthIndicator Alternate namesMeerlingIndicator DefinitionAn indication stating whether the patient is of a multiple birth.
For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).
boolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-24 (bool), PID-25 (integer)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
- cda: n/a
- zib-patient-v3.2-2020EN: NL-CM:0.1.31
|
| photo | C | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photo Short descriptionImage of the patient DefinitionRequirementsMany EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
Guidelines:
- Use id photos, not clinical photos.
- Limit dimensions to thumbnail.
- Keep byte count low to ease resource updates.
Attachment ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - att-1: If the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists()
Mappings- rim: n/a
- v2: ED/RP
- rim: ED
- v2: OBX-5 - needs a profile
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
- cda: n/a
|
| contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contact Short descriptionContact Alternate namesContactpersoon DefinitionA contact party (e.g. guardian, partner, friend) for the patient.
Need to track people you can contact about the patient.
Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:
- The RelatedPerson resource is used to capture information about any person that is related to the patient, using the profile http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson.
- Information about persons that should be contacted regarding the care for the patient is captured using the
Patient.contact resource.
If a person is both a related person and a contact person, then some data duplication is inevitable. The nl-core-ContactPerson can be referenced using the extension in contact:contactPerson.
BackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - pat-1: SHALL at least contain a contact's details or a reference to an organization
name.exists() or telecom.exists() or address.exists() or organization.exists()
Mappings- rim: n/a
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
- cda: n/a
- zib-contactperson-v3.4-2020EN: NL-CM:3.1.1
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| contactPerson | C | 0..1 | Extension(Reference(RelatedPerson)) | There are no (further) constraints on this element Element idPatient.contact.extension:contactPerson Short descriptionThis contact may have further details in this RelatedPerson Alternate namesextensions, user content DefinitionIn some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate.
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.
Extension(Reference(RelatedPerson)) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-relatedPerson ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.extension:contactPerson.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.contact.extension:contactPerson.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.contact.extension:contactPerson.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/patient-relatedPerson Mappings |
| value[x] | | 1..1 | | There are no (further) constraints on this element Element idPatient.contact.extension:contactPerson.value[x] Short descriptionContact Alternate namesContactpersoon DefinitionConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- zib-contactperson-v3.4-2020EN: NL-CM:3.1.1
|
| valueReference | | | Reference(RelatedPerson | NlcoreContactPerson) | There are no (further) constraints on this element Data typeReference(RelatedPerson | NlcoreContactPerson) |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Short descriptionExtensions 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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| relationship | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship Short descriptionThe kind of relationship DefinitionThe nature of the relationship between the patient and the contact person.
Used to determine which contact person is the most relevant to approach, depending on circumstances.
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.
CodeableConcept SlicingUnordered, Open, by $this(Value) BindingThe nature of the relationship between a patient and a contact person for that patient.
PatientContactRelationship (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: NK1-7, NK1-3
- rim: code
- cda: n/a
|
| role | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship:role Short descriptionRole Alternate namesRol DefinitionDefines the role of the contact in relation to the patient.
Used to determine which contact person is the most relevant to approach, depending on circumstances.
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.
CodeableConcept BindingRolCodelijst (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: NK1-7, NK1-3
- rim: code
- cda: n/a
- zib-contactperson-v3.4-2020EN: NL-CM:3.1.2
|
| relationship | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationship:relationship Short descriptionRelationship Alternate namesRelatie DefinitionDefines the contact’s familial relationship to the patient.
Used to determine which contact person is the most relevant to approach, depending on circumstances.
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.
CodeableConcept BindingRelatieCodelijst (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: NK1-7, NK1-3
- rim: code
- cda: n/a
- zib-contactperson-v3.4-2020EN: NL-CM:3.1.3
|
| name | C | 0..1 | NlcoreNameInformation | There are no (further) constraints on this element Element idPatient.contact.name Short descriptionNameInformation Alternate namesNaamgegevens, nl-core-NameInformation DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name.
Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
This .name element accomodates the official parts of a Dutch name according to common international usage and optionally to the zib NameInformation v1.1 (2020). An official Dutch name is represented in FHIR as an ordinary international name, optionally augmented using extensions to specify how the last name is built up according to the Dutch rules if conformance to the zib is required. See the guidance on .family and on .extension:nameUsage for more information.
Systems that need to work in a Dutch context SHOULD support the extensions as specified in .given, .family and .extension:nameUsage. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Dutch contexts. This means that:
- If parts of the name are specified using one or more of the structured elements, the
.text element SHOULD be populated with a rendered version of the full name.
- If parts of the family name are specified using the extensions in
.family, the .family element SHOULD be populated with the full family name.
Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on .given on how to map the FirstNames and Initials concepts, and on .prefix/.suffix on how to map the Titles concept.
Note 2: This element should only contain a person's official names. The GivenName concept is represented in another .name element with .name.use = usual.
Note 3: The examples illustrate how the zib is mapped to FHIR.
NlcoreNameInformation ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() - zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() - nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
(family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
Mappings- rim: n/a
- v2: XPN
- rim: EN (actually, PN)
- servd: ProviderName
- v2: NK1-2
- rim: name
- cda: n/a
- zib-nameinformation-v1.1-2020EN: NL-CM:20.4.1
- zib-contactperson-v3.4-2020EN: NL-CM:3.1.4
|
| telecom | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom Short descriptionContactInformation Alternate namesContactgegevens DefinitionThe contact’s telephone number and/or e-mail address.
People have (primary) ways to contact them in some way such as phone, email.
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.
ContactPoint SlicingUnordered, Open, by $this(Profile) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: NK1-5, NK1-6, NK1-40
- rim: telecom
- cda: n/a
- zib-contactperson-v3.4-2020EN: NL-CM:3.1.6
- zib-contactinformation-v1.2-2020EN: NL-CM:20.6.1
|
| telephoneNumbers | C | 0..* | NlcoreContactInformationTelephoneNumbers | There are no (further) constraints on this element Element idPatient.contact.telecom:telephoneNumbers Short descriptionTelephoneNumbers Alternate namesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
People have (primary) ways to contact them in some way such as phone, email.
Implementation of the "TelephoneNumbers" concept of zib ContactInformation.
Please 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.
NlcoreContactInformationTelephoneNumbers ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: NK1-5, NK1-6, NK1-40
- rim: telecom
- cda: n/a
- zib-contactinformation-v1.2-2020EN: NL-CM:20.6.2
|
| emailAddresses | C | 0..* | NlcoreContactInformationEmailAddresses | There are no (further) constraints on this element Element idPatient.contact.telecom:emailAddresses Short descriptionEmailAddresses Alternate namesEmailAdressen, nl-core-ContactInformation-EmailAddresses DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
People have (primary) ways to contact them in some way such as phone, email.
Implementation of the "EmailAddresses" concept of zib ContactInformation.
NlcoreContactInformationEmailAddresses ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: NK1-5, NK1-6, NK1-40
- rim: telecom
- cda: n/a
- zib-contactinformation-v1.2-2020EN: NL-CM:20.6.3
|
| address | | 0..1 | NlcoreAddressInformation | There are no (further) constraints on this element Element idPatient.contact.address Short descriptionAddressInformation Alternate namesAdresgegevens, nl-core-AddressInformation DefinitionAn 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.
Need to keep track where the contact person can be contacted per postal mail or visited.
This element can and should not completely capture the AddressInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of nl-core-ContactPerson, which can then be referenced from this resource. See the comment on Patient.contact for more information.
NlcoreAddressInformation ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
- v2: NK1-4
- rim: addr
- cda: n/a
- zib-addressinformation-v1.1-2020EN: NL-CM:20.5.1
- zib-contactperson-v3.4-2020EN: NL-CM:3.1.5
|
| gender | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
Needed to address the person correctly.
Note that FHIR strings SHALL NOT exceed 1MB in size
code BindingThe gender of a person used for administrative purposes.
AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: NK1-15
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: n/a
|
| organization | C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Short descriptionOrganization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working.
For guardians or business related contacts, the organization is relevant.
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.
Reference(Organization) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, pat-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
- rim: scoper
- cda: n/a
|
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.period Short descriptionThe period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient.
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.
Period ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- rim: effectiveTime
- cda: n/a
|
| communication | | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communication Short descriptionLanguageProficiency Alternate namesTaalvaardigheid DefinitionA language which may be used to communicate with the patient about his or her health.
If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.
If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
BackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: LanguageCommunication
- cda: patient.languageCommunication
- zib-languageproficiency-v3.2-2020EN: NL-CM:7.12.1
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| languageControl | C | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl Short descriptionLanguageControlListening / LanguageControlSpeaking / LanguageControlReading Alternate namesextensions, user content, TaalvaardigheidBegrijpen, TaalvaardigheidSpreken, TaalvaardigheidLezen DefinitionThe ability to understand spoken text in the language in question.
The ability to express oneself in spoken language.
The ability to understand written text in he language in question.
The zib concepts LanguageControlListening, LanguageControlReading, LanguageControlSpeaking are captured using a core extension from the R4 FHIR specification. Each of these three concepts is encoded as a copy of the extension, typed using the code in the type slice according to the following mapping:
- LanguageControlListening maps to code 'RSP' (Received spoken)
- LanguageControlReading maps to code 'RWR' (Received written)
- LanguageControlSpeaking maps to code 'ESP' (Expressed spoken)
Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-proficiency ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings- rim: n/a
- rim: N/A
- zib-languageproficiency-v3.2-2020EN: NL-CM:7.12.6
- zib-languageproficiency-v3.2-2020EN: NL-CM:7.12.7
- zib-languageproficiency-v3.2-2020EN: NL-CM:7.12.8
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.id Short descriptionUnique 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.
string Mappings |
| extension | C | 2..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| level | C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:level Short descriptionThe proficiency level of the communication Alternate namesextensions, user content DefinitionHow well the patient can communicate this communication (good, poor, etc.).
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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:level.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:level.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:level.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuelevel Mappings |
| value[x] | | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:level.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The zib ValueSets TaalvaardigheidBegrijpenCodelijst, TaalvaardigheidSprekenCodelijst and TaalvaardigheidLezenCodelijst are equal to the default FHIR ValueSet.
The proficiency level for the communication.
v3.LanguageAbilityProficiency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| valueCoding | | | Coding | There are no (further) constraints on this element Data typeCoding |
| type | C | 1..1 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:type Short descriptionThe proficiency type of the communication Alternate namesextensions, user content DefinitionWhat type of communication for the proficiency (spoken, written, etc.).
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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:type.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:type.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:type.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuetype Mappings |
| value[x] | | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.extension:type.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The proficiency type for the communication.
v3.LanguageAbilityMode (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| valueCoding | | | Coding | There are no (further) constraints on this element Data typeCoding |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Fixed valuehttp://hl7.org/fhir/StructureDefinition/patient-proficiency Mappings |
| value[x] | | 0..0 | | There are no (further) constraints on this element Element idPatient.communication.extension:languageControl.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| communicationDetails | C | 0..* | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.communication.extension:communicationDetails Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
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.
Extension(CodeableConcept) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Short descriptionExtensions 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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| language | | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.language Short descriptionCommunicationLanguage Alternate namesCommunicatieTaal DefinitionThe language of communication.
Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
CodeableConcept BindingCommunicatieTaalCodelijst
CommunicatieTaalCodelijst (required) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: PID-15, LAN-2
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
- cda: .languageCode
- zib-languageproficiency-v3.2-2020EN: NL-CM:7.12.3
|
| preferred | | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Short descriptionLanguage preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).
People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.
This language is specifically identified for communicating healthcare information.
boolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: PID-15
- rim: preferenceInd
- cda: .preferenceInd
|
| generalPractitioner | C | 0..* | Reference(Organization | Practitioner | PractitionerRole | NlcoreHealthProfessionalPractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Short descriptionPatient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider.
Each occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of nl-core-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of nl-core-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.
In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.
Reference(Organization | Practitioner | PractitionerRole | NlcoreHealthProfessionalPractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: PD1-4
- rim: subjectOf.CareEvent.performer.AssignedEntity
- cda: n/a
|
| managingOrganization | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Short descriptionOrganization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record.
Need to know who recognizes this patient record, manages and updates it.
There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).
Reference(Organization) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: scoper
- cda: .providerOrganization
|
| link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.link Short descriptionLink to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient.
There are multiple use cases:
- Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
- Distribution of patient information across multiple servers.
There is no assumption that linked patient records have mutual links.
BackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: outboundLink
- cda: n/a
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.id Short descriptionUnique 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.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extension Short descriptionAdditional 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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Short descriptionExtensions 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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| other | Σ C | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.other Short descriptionThe other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to.
Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.
Reference(Patient | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: PID-3, MRG-1
- rim: id
- cda: n/a
|
| type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.type Short descriptionreplaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource.
Note that FHIR strings SHALL NOT exceed 1MB in size
code BindingThe type of link between this patient resource and another patient resource.
LinkType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- rim: typeCode
- cda: n/a
|
