RIVO-Noord Zorgviewer Implementation Guide
1.23.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.23.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Patient

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Patient | Version: 1.23.0
Active as of 2026-03-30 | Computable Name: Patient

Patient en Contactgegevens

> 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.

### Zorginformatiebouwstenen

- ZIB Patient
- ZIB Contactpersoon

### View Definition

N.B. Er is alleen een View gedefinieerd voor het onderdeel contactpersonen van Patient.

- ViewDefinition voor Contactpersonen

### UI Wireframe

Contactpersonen

>< | Bron | Rol | Relatie | Naam | Telefoonnummer | E-mail
--- | --- | --- | --- | --- | --- | ---
+ | Chipsoft | Eerste relatie/contactpersoon | Echtgenote | Jannie J.P.M van Putten Helleman | +31612345678 | XXX_Helleman@hotmail.com
| Adres Knolweg 1000 9999XA STITSWERD
+ | Epic-CP | Contactpersoon bij nood | Husband | Noodcontact,Joost | +31 6 11 22 33 44 | noodcontact@joost.nl
+ | Epic-CP | Wettelijke verzorger | Daughter | Wettelijk,Heleen | +31 6 22 33 44 55 | Wettelijk@heleen.nl
+ | Epic |  | Wife | J.P.M. van Putten-XXX-helleman | 06 12 34 56 78 | xxx_helleman@hotmail.com
| Adres Knolweg 1000 9999 XA Stitswerd
+ | Nexus | Eerste relatie/contactpersoon | Echtgenote | Jannie J.P.M. van Putten-XXX-Helleman | 06-12345678 | XXX_Helleman@hotmail.com
| Adres Knolweg 1000 9999XA STITSWERD

### Kolomdefinities

Kolom label | FHIR Path Expression | FHIR Type | Zib element | Toelichting of regels
Bron | `meta.extension('http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source').valueUri` | `string` | nvt | Lookup adhv uri (AGB-Z of OID) `<adressering-base>/Organization?identifier=<.meta.tag.code>` en gebruik dan `Organization.name`
Rol | `relationship.where(coding.system='urn:oid:2.16.840.1.113883.2.4.3.11.22.472' or coding.system='http://terminology.hl7.org/CodeSystem/v3-RoleClass' or coding.system='http://terminology.hl7.org/CodeSystem/v2-0131').select(text | coding.display)` | `string` | Rol |
Relatie | `relationship.where(coding.system='http://hl7.org/fhir/v3/RoleCode').select(text | coding.display)` | `string` | Relatie |
Naam | `name.select(text | given.join(' ') + ' ' + family)` | `string` | Naamgegevens |
Telefoonnummer | `telecom.where(system='phone').value` | `string` | Contactgegevens.Telefoonnummers.Telefoonnummer |
E-mail | `telecom.where(system='email').value` | `string` | Contactgegevens.EmailAdressen.EmailAdres |
UITKLAPVELD
+Adres | `address.line.select(iif(getValue().exists(), getValue(), extension.value.join(' '))) + ' ' + address.postalCode + ' ' + address.city` | `string` | Contactgegevens.Adresgegevens |

LET OP: paden zijn relatief aan `Patient.contact`.

### Patient.name algoritme

Bovenop constraint zv-pat-1:

1. als `name[].use` gebruik dan de `name[use="official"]`, anders de 1ste `name[0]`
2. als `name[].text` gebruik die, anders concatenate de 1ste `name[].given[0]` met de `name[].family`

### Requests

1. Opvragen (search) naar patient op basis van de BSN

   `GET <bronsysteem-ontsluiting-base/Patient?identifier=<BSN>`

2. 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>`

3. Of (Sanday) opvragen (match) middels POST, zie: FHIR STU3 operation-patient-match

   `POST <bronsysteem-ontsluiting-base/Patient/$match`

        {
          "resourceType": "Patient",
          "identifier": [ {
            "use": "official",
            "system": "http://fhir.nl/fhir/NamingSystem/bsn",
            "value": "123456789"
          } ]
        }

4. Opvragen (read) patient op basis van de fhir_patient_id

   `GET <ontsluiten-bronsysteem-base>/Patient/<fhir_patient_id>`

### Response

1. Bundle met 1 Patient

   Dit is de gewenste situatie.

2. Bundle met meer dan 1 Patient

   Dit kan gebeuren na een SEH opname als de patient nog niet samengevoegd is.

3. 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.

### Bronsysteem herkennen

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.

Usages:

- CapabilityStatements using this Profile: Ontsluiten Bronsysteem - Sanday, Ontsluiten Bronsysteem and Zorgviewer Host
- This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 1.22.0:

- New Content

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
extension:preferredPharmacy |  | 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
extension: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 | Nationality Code
url |  | 1..1 | uri | "code"
extension:period |  | 0..1 | Extension | Nationality Period
url |  | 1..1 | uri | "period"
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
extension:legalStatus |  | 0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1
extension:lifeStance |  | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
value[x] |  | 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 | S Σ C | 1..* | nl-core-humanname | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2, zv-pat-1, zv-pat-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"}
Slices for extension |  |  |  | Content/Rules for all slices
extension:humannameAssemblyOrder |  | 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
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): The gender of a person used for administrative purposes.
Slices for extension |  |  |  | Content/Rules for all slices
extension:GeslachtCodelijst |  | 0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
value[x] |  | 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 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"}
contact | S C | 0..* | BackboneElement | ContactPerson Constraints: pat-1
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 | S | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
relationship:role | S | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
name | S C | 0..1 | nl-core-humanname | 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"}
Slices for extension |  |  |  | Content/Rules for all slices
extension:humannameAssemblyOrder |  | 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
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
telecom | S C | 0..* | nl-core-contactpoint | 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"}
address | C | 0..1 | nl-core-address | 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"}
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
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
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

#### Terminology Bindings

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.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.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.animal.species | Base | example | AnimalSpecies | 📦3.0.2 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📦3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cpt-2 | error | 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.contact.name.extension:humannameAssemblyOrder | 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, 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()`
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | nl-core-patient | Patient
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:BSN | S | 1..1 | Identifier | BSN
name | S C | 1..* | nl-core-humanname | NameInformation Constraints: zv-pat-1, zv-pat-2
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
contact | S | 0..* | BackboneElement | ContactPerson
Slices for relationship |  |  |  | Content/Rules for all slices
relationship:relationship | S | 0..* | CodeableConcept | Relationship
relationship:role | S | 0..* | CodeableConcept | Role
name | S | 0..1 | nl-core-humanname | NameInformation
telecom | S | 0..* | nl-core-contactpoint | ContactInformation
managingOrganization | S | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:preferredPharmacy |  | 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
extension: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 | Nationality Code
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"
valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship.
extension:period |  | 0..1 | Extension | Nationality Period
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"
valuePeriod |  | 0..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
extension:legalStatus |  | 0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1
extension:lifeStance |  | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
value[x] |  | 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 | S Σ C | 1..* | nl-core-humanname | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2, zv-pat-1, zv-pat-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"}
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:humannameAssemblyOrder |  | 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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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
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
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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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 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"}
gender | S Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
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:GeslachtCodelijst |  | 0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
value[x] |  | 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 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"}
maritalStatus |  | 0..1 | CodeableConcept | MaritalStatus Binding: BurgerlijkeStaatCodelijst (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | MultipleBirthIndicator
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | ContactPerson Constraints: pat-1
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 | S | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
relationship:role | S | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
name | S C | 0..1 | nl-core-humanname | 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"}
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:humannameAssemblyOrder |  | 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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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
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
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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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 | S C | 0..* | nl-core-contactpoint | 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"}
address | C | 0..1 | nl-core-address | 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"}
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:languageProficiency |  | 0..* | (Complex) | Proficiency level of the communication URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency Constraints: ext-1
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 2..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:type |  | 1..1 | Extension | The proficiency type of the communication
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "type"
Slices for valueCoding |  |  |  | Content/Rules for all slices
valueCoding:valueCoding |  | 1..1 | Coding | Value of extension Binding: LanguageAbilityMode (extensible): The proficiency type for the communication.
extension:level |  | 1..1 | Extension | The proficiency level of the communication
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "level"
Slices for valueCoding |  |  |  | Content/Rules for all slices
valueCoding:valueCoding |  | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (extensible): The proficiency level for the communication.
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency"
extension:comment |  | 0..* | string | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
language |  | 1..1 | CodeableConcept | CommunicationLanguage Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
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

#### Terminology Bindings

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.

#### Constraints

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()`
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

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
extension:preferredPharmacy |  | 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
extension: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 | Nationality Code
url |  | 1..1 | uri | "code"
extension:period |  | 0..1 | Extension | Nationality Period
url |  | 1..1 | uri | "period"
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
extension:legalStatus |  | 0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1
extension:lifeStance |  | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
value[x] |  | 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 | S Σ C | 1..* | nl-core-humanname | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2, zv-pat-1, zv-pat-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"}
Slices for extension |  |  |  | Content/Rules for all slices
extension:humannameAssemblyOrder |  | 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
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): The gender of a person used for administrative purposes.
Slices for extension |  |  |  | Content/Rules for all slices
extension:GeslachtCodelijst |  | 0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
value[x] |  | 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 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"}
contact | S C | 0..* | BackboneElement | ContactPerson Constraints: pat-1
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 | S | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
relationship:role | S | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
name | S C | 0..1 | nl-core-humanname | 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"}
Slices for extension |  |  |  | Content/Rules for all slices
extension:humannameAssemblyOrder |  | 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
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
telecom | S C | 0..* | nl-core-contactpoint | 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"}
address | C | 0..1 | nl-core-address | 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"}
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
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
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

#### Terminology Bindings

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.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.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.animal.species | Base | example | AnimalSpecies | 📦3.0.2 | FHIR Std.
Patient.link.type | Base | required | LinkType | 📦3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
cpt-2 | error | 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.contact.name.extension:humannameAssemblyOrder | 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, 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()`
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()`

Differential View

This structure is derived from nl-core-patient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | nl-core-patient | Patient
Slices for identifier |  |  |  | Content/Rules for all slices
identifier:BSN | S | 1..1 | Identifier | BSN
name | S C | 1..* | nl-core-humanname | NameInformation Constraints: zv-pat-1, zv-pat-2
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
contact | S | 0..* | BackboneElement | ContactPerson
Slices for relationship |  |  |  | Content/Rules for all slices
relationship:relationship | S | 0..* | CodeableConcept | Relationship
relationship:role | S | 0..* | CodeableConcept | Role
name | S | 0..1 | nl-core-humanname | NameInformation
telecom | S | 0..* | nl-core-contactpoint | ContactInformation
managingOrganization | S | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
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 Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:preferredPharmacy |  | 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
extension: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 | Nationality Code
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"
valueCodeableConcept |  | 0..1 | CodeableConcept | Value of extension Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship.
extension:period |  | 0..1 | Extension | Nationality Period
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"
valuePeriod |  | 0..1 | Period | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality"
extension:legalStatus |  | 0..2 | CodeableConcept | legalStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist Constraints: ext-1
extension:lifeStance |  | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance Constraints: ext-1
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
value[x] |  | 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 | S Σ C | 1..* | nl-core-humanname | NameInformation Constraints: nl-core-humanname-1, nl-core-humanname-2, zv-pat-1, zv-pat-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"}
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:humannameAssemblyOrder |  | 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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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
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
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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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 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"}
gender | S Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
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:GeslachtCodelijst |  | 0..1 | (Complex) | Gender URL: http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints: ext-1
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/code-specification"
value[x] |  | 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 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"}
maritalStatus |  | 0..1 | CodeableConcept | MaritalStatus Binding: BurgerlijkeStaatCodelijst (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | MultipleBirthIndicator
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..* | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | ContactPerson Constraints: pat-1
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 | S | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
relationship:role | S | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and a contact person for that patient.
name | S C | 0..1 | nl-core-humanname | 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"}
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:humannameAssemblyOrder |  | 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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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
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
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
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension: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 | S C | 0..* | nl-core-contactpoint | 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"}
address | C | 0..1 | nl-core-address | 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"}
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:languageProficiency |  | 0..* | (Complex) | Proficiency level of the communication URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency Constraints: ext-1
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 2..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:type |  | 1..1 | Extension | The proficiency type of the communication
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "type"
Slices for valueCoding |  |  |  | Content/Rules for all slices
valueCoding:valueCoding |  | 1..1 | Coding | Value of extension Binding: LanguageAbilityMode (extensible): The proficiency type for the communication.
extension:level |  | 1..1 | Extension | The proficiency level of the communication
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..0 |  | Additional Content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "level"
Slices for valueCoding |  |  |  | Content/Rules for all slices
valueCoding:valueCoding |  | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (extensible): The proficiency level for the communication.
url |  | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency"
extension:comment |  | 0..* | string | Comment URL: http://nictiz.nl/fhir/StructureDefinition/Comment Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
language |  | 1..1 | CodeableConcept | CommunicationLanguage Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
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 | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
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

#### Terminology Bindings

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.

#### Constraints

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()`
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

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Other representations of profile: CSV, Excel, Schematron