IKNL PZP STU3
1.0.0-alpha1 - consultation
IKNL PZP STU3, published by IKNL. This guide is not an authorized publication; it is the continuous build for version 1.0.0-alpha1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IKNL/PZP-FHIR-STU3/ and changes regularly. See the Directory of published versions
| Official URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient | Version: 1.0.0-alpha1 | |||
| Draft as of 2025-10-30 | Computable Name: ACPPatient | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
A person who receives medical, psychological, paramedical, or nursing care. Based on nl-core-Patient and HCIM Patient.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | nl-core-patient(2.2.5) | Patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Code | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Period | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "period" | |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
![]() ![]() ![]() |
0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | LifeStance Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (preferred): LevensovertuigingCodelijst | |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
C | 0..1 | (Complex) | ext LegallyCapable regarding medical treatment decisions URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapable" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapableComment" | |
![]() ![]() ![]() ![]() |
1..1 | uri | "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions" | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | BSN |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | BSN (Burgerservicenummer (Dutch person identification number)) Example General: 123456 Example Example of a burgerservicenummer: 123456782 |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
ΣC | 0..* | nl-core-humanname(2.0.10) | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2 Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma XXX_Helleman-de Haas","family":"XXX_Helleman-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"XXX_Helleman"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]} Example Unstructured HumanName: {"text":"Irma XXX_Helleman-de Haas"} |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Binding: HumanNameAssemblyOrder (required): Human Name Assembly Order | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name |
![]() ![]() ![]() |
Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type | |
![]() ![]() |
ΣC | 0..* | nl-core-contactpoint(2.0.8) | ContactInformation Constraints: cpt-2 Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} |
![]() ![]() |
Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst | |
![]() ![]() |
Σ | 0..1 | date | Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted. |
![]() ![]() |
?!Σ | 0..1 | DeathIndicator/DateOfDeath | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
ΣC | 0..* | nl-core-address(3.0.6) | AddressInformation Constraints: nl-streetname-if-official-and-other-line-parts Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} |
![]() ![]() |
?!Σ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example): The species of an animal. |
![]() ![]() |
0..1 | Reference(nl-core-organization(2.0.6) | nl-core-practitioner(2.0.7)) | GeneralPractitioner | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.extension:lifeStance.value[x] | Base | preferred | LevensovertuigingCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.identifier:BSN.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder<br/>[CanonicalType[http://hl7.org/fhir/StructureDefinition/humanname-assembly-order]] | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍3.0.2 | FHIR Std. |
| Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCode | Base | required | EntityNamePartQualifier | 📍3.0.2 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍3.0.2 | FHIR Std. |
| Patient.gender.extension:GeslachtCodelijst.value[x] | Base | extensible | GeslachtCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.animal.species | Base | example | AnimalSpecies | 📍3.0.2 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| dom-1 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Patient | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | Patient.extension:preferredPharmacy, Patient.extension:nationality, Patient.name.extension:humannameAssemblyOrder, Patient.name.given.extension:iso21090EnQualifier | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ext-1 | error | Patient.extension:legalStatus, Patient.extension:lifeStance, Patient.gender.extension:GeslachtCodelijst, Patient.generalPractitioner.extension:practitionerRole | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nl-core-humanname-1 | error | Patient.name | if you specify a prefix for an own name then an own name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
|
| nl-core-humanname-2 | error | Patient.name | if you specify a voorvoegsel for a partner name then a partner name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
|
| nl-streetname-if-official-and-other-line-parts | error | Patient.address |
Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value Requirements: This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
(extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
|
This structure is derived from nl-core-patient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | nl-core-patient(2.2.5) | Patient | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
C | 0..1 | (Complex) | ext LegallyCapable regarding medical treatment decisions URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() |
0..* | Identifier | PatientIdentificationNumber | |
![]() ![]() |
0..* | nl-core-humanname(2.0.10) | NameInformation | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | own-prefix | Voorvoegsel derived from person's own surname | |
![]() ![]() ![]() ![]() ![]() |
0..1 | own-name | Portion derived from person's own surname | |
![]() ![]() ![]() ![]() ![]() |
0..1 | partner-prefix | Voorvoegsel derived from person's partner's surname | |
![]() ![]() ![]() ![]() ![]() |
0..1 | partner-name | Portion derived from person's partner's surname | |
![]() ![]() ![]() |
0..* | string | Given | |
![]() ![]() |
0..* | nl-core-contactpoint(2.0.8) | ContactInformation | |
![]() ![]() |
0..1 | code | Gender | |
![]() ![]() |
0..1 | date | Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted. | |
![]() ![]() |
0..* | nl-core-address(3.0.6) | AddressInformation | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | nl-core-patient(2.2.5) | Patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Code | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NationaliteitCodelijst (2017-12-31T00:00:00) (extensible): Indicates the country of citizenship. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Period | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "period" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Value of extension | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |||||
![]() ![]() ![]() |
0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | LifeStance Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (preferred): LevensovertuigingCodelijst | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
C | 0..1 | (Complex) | ext LegallyCapable regarding medical treatment decisions URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapable" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | LegallyCapable | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapableComment" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | LegallyCapableComment | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions" | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | BSN | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | BSN (Burgerservicenummer (Dutch person identification number)) Example General: 123456 Example Example of a burgerservicenummer: 123456782 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
ΣC | 0..* | nl-core-humanname(2.0.10) | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2 Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma XXX_Helleman-de Haas","family":"XXX_Helleman-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"XXX_Helleman"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]} Example Unstructured HumanName: {"text":"Irma XXX_Helleman-de Haas"} | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Binding: HumanNameAssemblyOrder (required): Human Name Assembly Order | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Surname | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
ΣC | 0..* | nl-core-contactpoint(2.0.8) | ContactInformation Constraints: cpt-2 Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} | ||||
![]() ![]() |
Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst | |||||
![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() |
Σ | 0..1 | date | Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted. | ||||
![]() ![]() |
?!Σ | 0..1 | DeathIndicator/DateOfDeath | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
ΣC | 0..* | nl-core-address(3.0.6) | AddressInformation Constraints: nl-streetname-if-official-and-other-line-parts Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} | ||||
![]() ![]() |
0..1 | CodeableConcept | MaritalStatus Binding: BurgerlijkeStaatCodelijst (2017-12-31T00:00:00) (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | MultipleBirthIndicator | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | ContactPerson Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:$this Binding: v2 Contact Role (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (2017-12-31T00:00:00) (required): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Role Binding: RolCodelijst (2017-12-31T00:00:00) (required): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() |
C | 0..1 | nl-core-humanname(2.0.10) | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2 Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma XXX_Helleman-de Haas","family":"XXX_Helleman-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"XXX_Helleman"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]} Example Unstructured HumanName: {"text":"Irma XXX_Helleman-de Haas"} | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Binding: HumanNameAssemblyOrder (required): Human Name Assembly Order | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Surname | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | PrefixOwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | OwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | PrefixSurname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LastNamePartner URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
C | 0..* | nl-core-contactpoint(2.0.8) | ContactInformation Constraints: cpt-2 Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} | ||||
![]() ![]() ![]() |
C | 0..1 | nl-core-address(3.0.6) | AddressInformation Constraints: nl-streetname-if-official-and-other-line-parts Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} | ||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
?!Σ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example): The species of an animal. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example): The breed of an animal. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example): The state of the animal's reproductive organs. | ||||
![]() ![]() |
0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Proficiency level of the communication URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | The proficiency type of the communication | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "type" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: LanguageAbilityMode|2016-11-11 (extensible): The proficiency type for the communication. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | The proficiency level of the communication | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "level" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency|2016-11-11 (extensible): The proficiency level for the communication. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency" | |||||
![]() ![]() ![]() ![]() |
0..* | string | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | CommunicationLanguage Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..1 | Reference(nl-core-organization(2.0.6) | nl-core-practitioner(2.0.7)) | GeneralPractitioner | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Patient.extension:nationality.extension:code.valueCodeableConcept | Base | extensible | NationaliteitCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.extension:lifeStance.value[x] | Base | preferred | LevensovertuigingCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.identifier:BSN.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| Patient.identifier:BSN.type | Base | extensible | Identifier Type Codes | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder<br/>[CanonicalType[http://hl7.org/fhir/StructureDefinition/humanname-assembly-order]] | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍3.0.2 | FHIR Std. |
| Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCode | Base | required | EntityNamePartQualifier | 📍3.0.2 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍3.0.2 | FHIR Std. |
| Patient.gender.extension:GeslachtCodelijst.value[x] | Base | extensible | GeslachtCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.maritalStatus | Base | extensible | BurgerlijkeStaatCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.contact.relationship | Base | extensible | v2 Contact Role | 📍2.8.2 | FHIR Std. |
| Patient.contact.relationship:relationship | Base | required | RelatieCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.contact.relationship:role | Base | required | RolCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.contact.name.extension:humannameAssemblyOrder<br/>[CanonicalType[http://hl7.org/fhir/StructureDefinition/humanname-assembly-order]] | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.contact.name.extension:humannameAssemblyOrder.valueCode:valueCode | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍3.0.2 | FHIR Std. |
| Patient.contact.name.given.extension:iso21090EnQualifier.valueCode:valueCode | Base | required | EntityNamePartQualifier | 📍3.0.2 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍3.0.2 | FHIR Std. |
| Patient.animal.species | Base | example | AnimalSpecies | 📍3.0.2 | FHIR Std. |
| Patient.animal.breed | Base | example | AnimalBreeds | 📍3.0.2 | FHIR Std. |
| Patient.animal.genderStatus | Base | example | GenderStatus | 📍3.0.2 | FHIR Std. |
| Patient.communication.extension:languageProficiency.extension:type.valueCoding:valueCoding | Base | extensible | v3 Code System LanguageAbilityMode | 📍2016-11-11 | FHIR Std. |
| Patient.communication.extension:languageProficiency.extension:level.valueCoding:valueCoding | Base | extensible | v3 Code System LanguageAbilityProficiency | 📍2016-11-11 | FHIR Std. |
| Patient.communication.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | Patient.telecom, Patient.contact.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| dom-1 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Patient | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | Patient.extension:preferredPharmacy, Patient.extension:nationality, Patient.name.extension:humannameAssemblyOrder, Patient.name.family.extension:humannameOwnPrefix, Patient.name.family.extension:humannameOwnName, Patient.name.family.extension:humannamePartnerPrefix, Patient.name.family.extension:humannamePartnerName, Patient.name.given.extension:iso21090EnQualifier, Patient.contact.name.extension:humannameAssemblyOrder, Patient.contact.name.family.extension:humannameOwnPrefix, Patient.contact.name.family.extension:humannameOwnName, Patient.contact.name.family.extension:humannamePartnerPrefix, Patient.contact.name.family.extension:humannamePartnerName, Patient.contact.name.given.extension:iso21090EnQualifier | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ext-1 | error | Patient.extension:legalStatus, Patient.extension:lifeStance, Patient.gender.extension:GeslachtCodelijst, Patient.communication.extension:languageProficiency, Patient.communication.extension:comment, Patient.generalPractitioner.extension:practitionerRole | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nl-core-humanname-1 | error | Patient.name, Patient.contact.name | if you specify a prefix for an own name then an own name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
|
| nl-core-humanname-2 | error | Patient.name, Patient.contact.name | if you specify a voorvoegsel for a partner name then a partner name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
|
| nl-streetname-if-official-and-other-line-parts | error | Patient.address, Patient.contact.address |
Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value Requirements: This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
(extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
|
| pat-1 | error | Patient.contact | 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()
|
This structure is derived from nl-core-patient
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | nl-core-patient(2.2.5) | Patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Code | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Period | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "period" | |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
![]() ![]() ![]() |
0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | LifeStance Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (preferred): LevensovertuigingCodelijst | |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
C | 0..1 | (Complex) | ext LegallyCapable regarding medical treatment decisions URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapable" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapableComment" | |
![]() ![]() ![]() ![]() |
1..1 | uri | "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions" | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 0..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | BSN |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | BSN (Burgerservicenummer (Dutch person identification number)) Example General: 123456 Example Example of a burgerservicenummer: 123456782 |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() |
ΣC | 0..* | nl-core-humanname(2.0.10) | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2 Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma XXX_Helleman-de Haas","family":"XXX_Helleman-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"XXX_Helleman"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]} Example Unstructured HumanName: {"text":"Irma XXX_Helleman-de Haas"} |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Binding: HumanNameAssemblyOrder (required): Human Name Assembly Order | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name |
![]() ![]() ![]() |
Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type | |
![]() ![]() |
ΣC | 0..* | nl-core-contactpoint(2.0.8) | ContactInformation Constraints: cpt-2 Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} |
![]() ![]() |
Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst | |
![]() ![]() |
Σ | 0..1 | date | Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted. |
![]() ![]() |
?!Σ | 0..1 | DeathIndicator/DateOfDeath | |
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() |
ΣC | 0..* | nl-core-address(3.0.6) | AddressInformation Constraints: nl-streetname-if-official-and-other-line-parts Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} |
![]() ![]() |
?!Σ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example): The species of an animal. |
![]() ![]() |
0..1 | Reference(nl-core-organization(2.0.6) | nl-core-practitioner(2.0.7)) | GeneralPractitioner | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.extension:lifeStance.value[x] | Base | preferred | LevensovertuigingCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.identifier:BSN.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder<br/>[CanonicalType[http://hl7.org/fhir/StructureDefinition/humanname-assembly-order]] | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍3.0.2 | FHIR Std. |
| Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCode | Base | required | EntityNamePartQualifier | 📍3.0.2 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍3.0.2 | FHIR Std. |
| Patient.gender.extension:GeslachtCodelijst.value[x] | Base | extensible | GeslachtCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.animal.species | Base | example | AnimalSpecies | 📍3.0.2 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | Patient.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| dom-1 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Patient | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | Patient.extension:preferredPharmacy, Patient.extension:nationality, Patient.name.extension:humannameAssemblyOrder, Patient.name.given.extension:iso21090EnQualifier | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ext-1 | error | Patient.extension:legalStatus, Patient.extension:lifeStance, Patient.gender.extension:GeslachtCodelijst, Patient.generalPractitioner.extension:practitionerRole | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nl-core-humanname-1 | error | Patient.name | if you specify a prefix for an own name then an own name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
|
| nl-core-humanname-2 | error | Patient.name | if you specify a voorvoegsel for a partner name then a partner name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
|
| nl-streetname-if-official-and-other-line-parts | error | Patient.address |
Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value Requirements: This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
(extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
|
Differential View
This structure is derived from nl-core-patient
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | nl-core-patient(2.2.5) | Patient | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
C | 0..1 | (Complex) | ext LegallyCapable regarding medical treatment decisions URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() |
0..* | Identifier | PatientIdentificationNumber | |
![]() ![]() |
0..* | nl-core-humanname(2.0.10) | NameInformation | |
![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | own-prefix | Voorvoegsel derived from person's own surname | |
![]() ![]() ![]() ![]() ![]() |
0..1 | own-name | Portion derived from person's own surname | |
![]() ![]() ![]() ![]() ![]() |
0..1 | partner-prefix | Voorvoegsel derived from person's partner's surname | |
![]() ![]() ![]() ![]() ![]() |
0..1 | partner-name | Portion derived from person's partner's surname | |
![]() ![]() ![]() |
0..* | string | Given | |
![]() ![]() |
0..* | nl-core-contactpoint(2.0.8) | ContactInformation | |
![]() ![]() |
0..1 | code | Gender | |
![]() ![]() |
0..1 | date | Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted. | |
![]() ![]() |
0..* | nl-core-address(3.0.6) | AddressInformation | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | nl-core-patient(2.2.5) | Patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Code | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "code" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: NationaliteitCodelijst (2017-12-31T00:00:00) (extensible): Indicates the country of citizenship. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Nationality Period | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "period" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Value of extension | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |||||
![]() ![]() ![]() |
0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | LifeStance Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (preferred): LevensovertuigingCodelijst | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
C | 0..1 | (Complex) | ext LegallyCapable regarding medical treatment decisions URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapable" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | LegallyCapable | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "legallyCapableComment" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | LegallyCapableComment | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions" | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | BSN | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | BSN (Burgerservicenummer (Dutch person identification number)) Example General: 123456 Example Example of a burgerservicenummer: 123456782 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() |
ΣC | 0..* | nl-core-humanname(2.0.10) | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2 Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma XXX_Helleman-de Haas","family":"XXX_Helleman-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"XXX_Helleman"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]} Example Unstructured HumanName: {"text":"Irma XXX_Helleman-de Haas"} | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Binding: HumanNameAssemblyOrder (required): Human Name Assembly Order | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Surname | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
ΣC | 0..* | nl-core-contactpoint(2.0.8) | ContactInformation Constraints: cpt-2 Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} | ||||
![]() ![]() |
Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst | |||||
![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() |
Σ | 0..1 | date | Patients date of birth. The date of birth is mandatory for a patient. An incomplete date, e.g. only year or only year + month, is permitted. | ||||
![]() ![]() |
?!Σ | 0..1 | DeathIndicator/DateOfDeath | |||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() |
ΣC | 0..* | nl-core-address(3.0.6) | AddressInformation Constraints: nl-streetname-if-official-and-other-line-parts Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} | ||||
![]() ![]() |
0..1 | CodeableConcept | MaritalStatus Binding: BurgerlijkeStaatCodelijst (2017-12-31T00:00:00) (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | MultipleBirthIndicator | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | ContactPerson Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:$this Binding: v2 Contact Role (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (2017-12-31T00:00:00) (required): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Role Binding: RolCodelijst (2017-12-31T00:00:00) (required): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() |
C | 0..1 | nl-core-humanname(2.0.10) | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2 Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma XXX_Helleman-de Haas","family":"XXX_Helleman-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"XXX_Helleman"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"],"_given":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier","valueCode":"CL"}]}]} Example Unstructured HumanName: {"text":"Irma XXX_Helleman-de Haas"} | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order Binding: HumanNameAssemblyOrder (required): Human Name Assembly Order | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Surname | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | PrefixOwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | OwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | PrefixSurname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LastNamePartner URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
C | 0..* | nl-core-contactpoint(2.0.8) | ContactInformation Constraints: cpt-2 Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} | ||||
![]() ![]() ![]() |
C | 0..1 | nl-core-address(3.0.6) | AddressInformation Constraints: nl-streetname-if-official-and-other-line-parts Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"12"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix","valueString":"A"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID","valueString":"Hoog"}]}],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"_line":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName","valueString":"Binnenkant"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator","valueString":"to"},{"url":"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber","valueString":"10"}]}],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} | ||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
?!Σ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example): The species of an animal. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example): The breed of an animal. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example): The state of the animal's reproductive organs. | ||||
![]() ![]() |
0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Proficiency level of the communication URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
2..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | The proficiency type of the communication | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "type" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: LanguageAbilityMode|2016-11-11 (extensible): The proficiency type for the communication. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | The proficiency level of the communication | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Additional Content defined by implementations Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "level" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency|2016-11-11 (extensible): The proficiency level for the communication. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency" | |||||
![]() ![]() ![]() ![]() |
0..* | string | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | CommunicationLanguage Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..1 | Reference(nl-core-organization(2.0.6) | nl-core-practitioner(2.0.7)) | GeneralPractitioner | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Patient.extension:nationality.extension:code.valueCodeableConcept | Base | extensible | NationaliteitCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.extension:lifeStance.value[x] | Base | preferred | LevensovertuigingCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.identifier:BSN.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| Patient.identifier:BSN.type | Base | extensible | Identifier Type Codes | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder<br/>[CanonicalType[http://hl7.org/fhir/StructureDefinition/humanname-assembly-order]] | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍3.0.2 | FHIR Std. |
| Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCode | Base | required | EntityNamePartQualifier | 📍3.0.2 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📍3.0.2 | FHIR Std. |
| Patient.gender.extension:GeslachtCodelijst.value[x] | Base | extensible | GeslachtCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.maritalStatus | Base | extensible | BurgerlijkeStaatCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.contact.relationship | Base | extensible | v2 Contact Role | 📍2.8.2 | FHIR Std. |
| Patient.contact.relationship:relationship | Base | required | RelatieCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.contact.relationship:role | Base | required | RolCodelijst | 📍2017-12-31T00:00:00 | Nictiz FHIR NL STU3 Zib2017 v2.3 |
| Patient.contact.name.extension:humannameAssemblyOrder<br/>[CanonicalType[http://hl7.org/fhir/StructureDefinition/humanname-assembly-order]] | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.contact.name.extension:humannameAssemblyOrder.valueCode:valueCode | Base | required | HumanNameAssemblyOrder | 📍3.0.2 | FHIR Std. |
| Patient.contact.name.use | Base | required | NameUse | 📍3.0.2 | FHIR Std. |
| Patient.contact.name.given.extension:iso21090EnQualifier.valueCode:valueCode | Base | required | EntityNamePartQualifier | 📍3.0.2 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍3.0.2 | FHIR Std. |
| Patient.animal.species | Base | example | AnimalSpecies | 📍3.0.2 | FHIR Std. |
| Patient.animal.breed | Base | example | AnimalBreeds | 📍3.0.2 | FHIR Std. |
| Patient.animal.genderStatus | Base | example | GenderStatus | 📍3.0.2 | FHIR Std. |
| Patient.communication.extension:languageProficiency.extension:type.valueCoding:valueCoding | Base | extensible | v3 Code System LanguageAbilityMode | 📍2016-11-11 | FHIR Std. |
| Patient.communication.extension:languageProficiency.extension:level.valueCoding:valueCoding | Base | extensible | v3 Code System LanguageAbilityProficiency | 📍2016-11-11 | FHIR Std. |
| Patient.communication.language | Base | extensible | Common Languages | 📍3.0.2 | FHIR Std. |
| Patient.link.type | Base | required | LinkType | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cpt-2 | error | Patient.telecom, Patient.contact.telecom | A system is required if a value is provided. |
value.empty() or system.exists()
|
| dom-1 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | Patient | 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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | Patient.extension:preferredPharmacy, Patient.extension:nationality, Patient.name.extension:humannameAssemblyOrder, Patient.name.family.extension:humannameOwnPrefix, Patient.name.family.extension:humannameOwnName, Patient.name.family.extension:humannamePartnerPrefix, Patient.name.family.extension:humannamePartnerName, Patient.name.given.extension:iso21090EnQualifier, Patient.contact.name.extension:humannameAssemblyOrder, Patient.contact.name.family.extension:humannameOwnPrefix, Patient.contact.name.family.extension:humannameOwnName, Patient.contact.name.family.extension:humannamePartnerPrefix, Patient.contact.name.family.extension:humannamePartnerName, Patient.contact.name.given.extension:iso21090EnQualifier | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| ext-1 | error | Patient.extension:legalStatus, Patient.extension:lifeStance, Patient.gender.extension:GeslachtCodelijst, Patient.communication.extension:languageProficiency, Patient.communication.extension:comment, Patient.generalPractitioner.extension:practitionerRole | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| nl-core-humanname-1 | error | Patient.name, Patient.contact.name | if you specify a prefix for an own name then an own name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
|
| nl-core-humanname-2 | error | Patient.name, Patient.contact.name | if you specify a voorvoegsel for a partner name then a partner name is also expected |
name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
|
| nl-streetname-if-official-and-other-line-parts | error | Patient.address, Patient.contact.address |
Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value Requirements: This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
(extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
|
| pat-1 | error | Patient.contact | 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()
|
This structure is derived from nl-core-patient
Other representations of profile: CSV, Excel, Schematron