RIVO-Noord Zorgviewer Implementation Guide
1.6.0 - sprint43
RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.6.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/Patient | Version: 1.6.0 | |||
Active as of 2024-10-17 | Computable Name: Patient |
Patient
Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.
Bovenop constraint zv-pat-1:
name[].use
gebruik dan de name[use="official"]
, anders de 1ste name[0]
name[].text
gebruik die, anders concatenate de 1ste name[].given[0]
met de name[].family
Opvragen (search) naar patient op basis van de BSN
GET <bronsysteem-ontsluiting-base/Patient?identifier=<BSN>
Of opvragen (search) middels POST, zie: FHIR STU3 http search
POST <bronsysteem-ontsluiting-base/Patient/_search
Content-Type: application/x-www-form-urlencoded
identifier=<BSN>
Opvragen (read) patient op basis van de fhir_patient_id
GET <ontsluiten-bronsysteem-base>/Patient/<fhir_patient_id>
Bundle met 1 Patient
Dit is de gewenste situatie.
Bundle met meer dan 1 Patient
Dit kan gebeuren na een SEH opname als de patient nog niet samengevoegd is.
Bundle zonder patienten of een HTTP Response 401/404
Dit gebeurt als de patient GEEN toestemming heeft gegeven of de patient simpelweg niet bestaat bij de bevraagde organisatie.
De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.
Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):
"meta": {
"extension": [ {
"url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
"valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
} ]
}
Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient
). Elke patient heeft een Patient.managingOrganization
en in de gerefereerde Organization.identifier
staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from nl-core-patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | nl-core-patient | Patient | |
Slices for identifier | Content/Rules for all slices | |||
identifier:BSN | S | 1..1 | Identifier | BSN |
name | SC | 1..* | nl-core-humanname | NameInformation zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
gender | S | 0..1 | code | Gender |
birthDate | S | 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. |
deceased[x] | S | 0..1 | boolean, dateTime | DeathIndicator/DateOfDeath |
managingOrganization | S | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
zv-pat-1 | error | Patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pat-2 | best practice | Patient.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | nl-core-patient | Patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
preferredPharmacy | 0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy | |
nationality | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
Slices for extension | Content/Rules for all slices | |||
extension:code | 0..1 | Extension | Extension | |
url | 1..1 | uri | "code" | |
Slices for valueCodeableConcept | Content/Rules for all slices | |||
valueCodeableConcept:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship. | |
extension:period | 0..1 | Extension | Extension | |
url | 1..1 | uri | "period" | |
Slices for valuePeriod | Content/Rules for all slices | |||
valuePeriod:valuePeriod | 0..1 | Period | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
legalStatus | 0..2 | (Complex) | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | LegalStatus Binding: JuridischeStatusCodelijst (extensible) | |
coding | Σ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
lifeStance | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | LifeStance Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:system |
identifier:BSN | SΣ | 1..1 | Identifier | BSN |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn |
value | Σ | 1..1 | string | BSN (Burgerservicenummer (Dutch person identification number)) Example General: 123456 Example Example of a burgerservicenummer: 123456782 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SC | 1..* | nl-core-humanname | NameInformation nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"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 Jongeneel-de Haas"} |
Slices for extension | Content/Rules for all slices | |||
humannameAssemblyOrder | 0..* | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
Slices for valueCode | Content/Rules for all slices | |||
valueCode:valueCode | 0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name |
gender | SΣ | 0..1 | code | Gender Binding: AdministrativeGender (required) |
Slices for extension | Content/Rules for all slices | |||
GeslachtCodelijst | 0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: GeslachtCodelijst (extensible): GeslachtCodelijst | |
birthDate | SΣ | 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. |
deceased[x] | ?!SΣ | 0..1 | DeathIndicator/DateOfDeath | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | C | 0..* | nl-core-address | AddressInformation nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value 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"} |
animal | ?!Σ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example): The species of an animal. |
generalPractitioner | 0..1 | Reference(nl-core-organization | nl-core-practitioner) | GeneralPractitioner | |
Slices for extension | Content/Rules for all slices | |||
practitionerRole | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
managingOrganization | SΣ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 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 | Conformance | ValueSet | URI |
Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConcept | extensible | NationaliteitCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.16.32 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20171231000000 | |
Patient.extension:legalStatus.value[x]:valueCodeableConcept | extensible | JuridischeStatusCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.3.2--20171231000000 | |
Patient.extension:lifeStance.value[x]:valueCodeableConcept | preferred | LevensovertuigingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.5.1--20171231000000 | |
Patient.identifier:BSN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | |
Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | |
Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConcept | extensible | GeslachtCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20171231000000 | |
Patient.animal.species | example | AnimalSpecieshttp://hl7.org/fhir/ValueSet/animal-species from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** extensions | 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 : (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 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 |
zv-pat-1 | error | Patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pat-2 | best practice | Patient.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | nl-core-patient | Patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
preferredPharmacy | 0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy | |||||
nationality | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
extension:code | 0..1 | Extension | Extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "code" | |||||
Slices for valueCodeableConcept | Content/Rules for all slices | |||||||
valueCodeableConcept:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship. | |||||
extension:period | 0..1 | Extension | Extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "period" | |||||
Slices for valuePeriod | Content/Rules for all slices | |||||||
valuePeriod:valuePeriod | 0..1 | Period | Value of extension | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |||||
legalStatus | 0..2 | (Complex) | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | LegalStatus Binding: JuridischeStatusCodelijst (extensible) | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
lifeStance | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance" | |||||
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | LifeStance Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:system | ||||
identifier:BSN | SΣ | 1..1 | Identifier | BSN | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 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. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | ||||
value | Σ | 1..1 | string | BSN (Burgerservicenummer (Dutch person identification number)) Example General: 123456 Example Example of a burgerservicenummer: 123456782 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | SC | 1..* | nl-core-humanname | NameInformation nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"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 Jongeneel-de Haas"} | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
humannameAssemblyOrder | 0..* | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
Slices for valueCode | Content/Rules for all slices | |||||||
valueCode:valueCode | 0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Surname | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
humannameOwnPrefix | 0..1 | (Complex) | PrefixOwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
humannameOwnName | 0..1 | (Complex) | OwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
humannamePartnerPrefix | 0..1 | (Complex) | PrefixSurname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
humannamePartnerName | 0..1 | (Complex) | LastNamePartner URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
given | Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
iso21090EnQualifier | 0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
Slices for valueCode | Content/Rules for all slices | |||||||
valueCode:valueCode | 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 | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | C | 0..* | nl-core-contactpoint | ContactInformation cpt-2: A system is required if a value is provided. 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"} | ||||
gender | SΣ | 0..1 | code | Gender Binding: AdministrativeGender (required) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
GeslachtCodelijst | 0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |||||
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: GeslachtCodelijst (extensible): GeslachtCodelijst | |||||
value | 0..1 | code | Primitive value for code | |||||
birthDate | SΣ | 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. | ||||
deceased[x] | ?!SΣ | 0..1 | DeathIndicator/DateOfDeath | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | C | 0..* | nl-core-address | AddressInformation nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value 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"} | ||||
maritalStatus | 0..1 | CodeableConcept | MaritalStatus Binding: BurgerlijkeStaatCodelijst (extensible) | |||||
multipleBirth[x] | 0..1 | MultipleBirthIndicator | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | ContactPerson pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for relationship | 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. | |||||
relationship:relationship | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required) | |||||
relationship:role | 0..* | CodeableConcept | Role Binding: RolCodelijst (required) | |||||
name | C | 0..1 | nl-core-humanname | NameInformation nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"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 Jongeneel-de Haas"} | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
humannameAssemblyOrder | 0..* | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
Slices for valueCode | Content/Rules for all slices | |||||||
valueCode:valueCode | 0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Surname | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
humannameOwnPrefix | 0..1 | (Complex) | PrefixOwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
humannameOwnName | 0..1 | (Complex) | OwnName URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
humannamePartnerPrefix | 0..1 | (Complex) | PrefixSurname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
humannamePartnerName | 0..1 | (Complex) | LastNamePartner URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
Slices for valueString | Content/Rules for all slices | |||||||
valueString:valueString | 0..1 | string | Value of extension | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
given | Σ | 0..* | string | Given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
iso21090EnQualifier | 0..1 | (Complex) | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" | |||||
Slices for valueCode | Content/Rules for all slices | |||||||
valueCode:valueCode | 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 | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | C | 0..* | nl-core-contactpoint | ContactInformation cpt-2: A system is required if a value is provided. 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"} | ||||
address | C | 0..1 | nl-core-address | AddressInformation nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value 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"} | ||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
animal | ?!Σ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example): The species of an animal. | ||||
breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example): The breed of an animal. | ||||
genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example): The state of the animal's reproductive organs. | ||||
communication | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
languageProficiency | 0..* | (Complex) | Proficiency level of the communication URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extension:type | 1..1 | Extension | Extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "type" | |||||
Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: LanguageAbilityMode (extensible) | |||||
extension:level | 1..1 | Extension | Extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "level" | |||||
Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (extensible) | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency" | |||||
comment | 0..* | string | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
language | 1..1 | CodeableConcept | CommunicationLanguage Binding: Common Languages (extensible): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..1 | Reference(nl-core-organization | nl-core-practitioner) | GeneralPractitioner | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
practitionerRole | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
managingOrganization | SΣ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 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 | Conformance | ValueSet | URI | |||
Patient.language | extensible | Common Languages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConcept | extensible | NationaliteitCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.16.32 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20171231000000 | ||||
Patient.extension:legalStatus.value[x]:valueCodeableConcept | extensible | JuridischeStatusCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.3.2--20171231000000 | ||||
Patient.extension:lifeStance.value[x]:valueCodeableConcept | preferred | LevensovertuigingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.5.1--20171231000000 | ||||
Patient.identifier:BSN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | ||||
Patient.identifier:BSN.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order from the FHIR Standard | ||||
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use from the FHIR Standard | ||||
Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCode | required | EntityNamePartQualifierhttp://hl7.org/fhir/ValueSet/name-part-qualifier from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | ||||
Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConcept | extensible | GeslachtCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20171231000000 | ||||
Patient.maritalStatus | extensible | BurgerlijkeStaatCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20171231000000 | ||||
Patient.contact.relationship | extensible | v2 Contact Rolehttp://hl7.org/fhir/ValueSet/v2-0131 from the FHIR Standard | ||||
Patient.contact.relationship:relationship | required | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20171231000000 | ||||
Patient.contact.relationship:role | required | RolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20171231000000 | ||||
Patient.contact.name.extension:humannameAssemblyOrder.valueCode:valueCode | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order from the FHIR Standard | ||||
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use from the FHIR Standard | ||||
Patient.contact.name.given.extension:iso21090EnQualifier.valueCode:valueCode | required | EntityNamePartQualifierhttp://hl7.org/fhir/ValueSet/name-part-qualifier from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | ||||
Patient.animal.species | example | AnimalSpecieshttp://hl7.org/fhir/ValueSet/animal-species from the FHIR Standard | ||||
Patient.animal.breed | example | AnimalBreedshttp://hl7.org/fhir/ValueSet/animal-breeds from the FHIR Standard | ||||
Patient.animal.genderStatus | example | GenderStatushttp://hl7.org/fhir/ValueSet/animal-genderstatus from the FHIR Standard | ||||
Patient.communication.extension:languageProficiency.extension:type.value[x]:valueCoding | extensible | v3 Code System LanguageAbilityModehttp://hl7.org/fhir/ValueSet/v3-LanguageAbilityMode from the FHIR Standard | ||||
Patient.communication.extension:languageProficiency.extension:level.value[x]:valueCoding | extensible | v3 Code System LanguageAbilityProficiencyhttp://hl7.org/fhir/ValueSet/v3-LanguageAbilityProficiency from the FHIR Standard | ||||
Patient.communication.language | extensible | Common Languages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** extensions | 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 : (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 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 |
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() | |
zv-pat-1 | error | Patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pat-2 | best practice | Patient.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() |
This structure is derived from nl-core-patient
Differential View
This structure is derived from nl-core-patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | nl-core-patient | Patient | |
Slices for identifier | Content/Rules for all slices | |||
identifier:BSN | S | 1..1 | Identifier | BSN |
name | SC | 1..* | nl-core-humanname | NameInformation zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
gender | S | 0..1 | code | Gender |
birthDate | S | 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. |
deceased[x] | S | 0..1 | boolean, dateTime | DeathIndicator/DateOfDeath |
managingOrganization | S | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
zv-pat-1 | error | Patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pat-2 | best practice | Patient.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | nl-core-patient | Patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
preferredPharmacy | 0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy | |
nationality | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
Slices for extension | Content/Rules for all slices | |||
extension:code | 0..1 | Extension | Extension | |
url | 1..1 | uri | "code" | |
Slices for valueCodeableConcept | Content/Rules for all slices | |||
valueCodeableConcept:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship. | |
extension:period | 0..1 | Extension | Extension | |
url | 1..1 | uri | "period" | |
Slices for valuePeriod | Content/Rules for all slices | |||
valuePeriod:valuePeriod | 0..1 | Period | Value of extension | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
legalStatus | 0..2 | (Complex) | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | LegalStatus Binding: JuridischeStatusCodelijst (extensible) | |
coding | Σ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
lifeStance | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | LifeStance Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:system |
identifier:BSN | SΣ | 1..1 | Identifier | BSN |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn |
value | Σ | 1..1 | string | BSN (Burgerservicenummer (Dutch person identification number)) Example General: 123456 Example Example of a burgerservicenummer: 123456782 |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SC | 1..* | nl-core-humanname | NameInformation nl-core-humanname-1: if you specify a prefix for an own name then an own name is also expected nl-core-humanname-2: if you specify a voorvoegsel for a partner name then a partner name is also expected zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"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 Jongeneel-de Haas"} |
Slices for extension | Content/Rules for all slices | |||
humannameAssemblyOrder | 0..* | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order | |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
Slices for valueCode | Content/Rules for all slices | |||
valueCode:valueCode | 0..1 | code | Value of extension Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name |
gender | SΣ | 0..1 | code | Gender Binding: AdministrativeGender (required) |
Slices for extension | Content/Rules for all slices | |||
GeslachtCodelijst | 0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification" | |
Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: GeslachtCodelijst (extensible): GeslachtCodelijst | |
birthDate | SΣ | 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. |
deceased[x] | ?!SΣ | 0..1 | DeathIndicator/DateOfDeath | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | C | 0..* | nl-core-address | AddressInformation nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value 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"} |
animal | ?!Σ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example): The species of an animal. |
generalPractitioner | 0..1 | Reference(nl-core-organization | nl-core-practitioner) | GeneralPractitioner | |
Slices for extension | Content/Rules for all slices | |||
practitionerRole | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
managingOrganization | SΣ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 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 | Conformance | ValueSet | URI |
Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConcept | extensible | NationaliteitCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.16.32 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20171231000000 | |
Patient.extension:legalStatus.value[x]:valueCodeableConcept | extensible | JuridischeStatusCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.14.3.2--20171231000000 | |
Patient.extension:lifeStance.value[x]:valueCodeableConcept | preferred | LevensovertuigingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.5.1--20171231000000 | |
Patient.identifier:BSN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use from the FHIR Standard | |
Patient.name.extension:humannameAssemblyOrder.valueCode:valueCode | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order from the FHIR Standard | |
Patient.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard | |
Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConcept | extensible | GeslachtCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20171231000000 | |
Patient.animal.species | example | AnimalSpecieshttp://hl7.org/fhir/ValueSet/animal-species from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 | **ALL** extensions | 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 : (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 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 |
zv-pat-1 | error | Patient.name | Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pat-2 | best practice | Patient.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | nl-core-patient | Patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
preferredPharmacy | 0..1 | Reference(nl-core-organization) | References a patient's preferered pharmacy URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy | |||||
nationality | 0..* | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
extension:code | 0..1 | Extension | Extension | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "code" | |||||