IKNL PZP STU3
1.0.0-alpha1 - consultation International flag

IKNL PZP STU3, published by IKNL. This guide is not an authorized publication; it is the continuous build for version 1.0.0-alpha1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IKNL/PZP-FHIR-STU3/ and changes regularly. See the Directory of published versions

Resource Profile: Patient

Official URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient Version: 1.0.0-alpha1
Draft as of 2025-10-23 Computable Name: ACPPatient

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

A person who receives medical, psychological, paramedical, or nursing care. Based on nl-core-Patient and HCIM Patient.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* nl-core-patient(2.2.4) 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
.... 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 Extension
....... url 1..1 uri "code"
....... Slices for valueCodeableConcept Content/Rules for all slices
........ valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: NationaliteitCodelijst (2017-12-31T00:00:00) (extensible): Indicates the country of citizenship.
...... extension:period 0..1 Extension Extension
....... url 1..1 uri "period"
....... Slices for valuePeriod Content/Rules for all slices
........ valuePeriod:valuePeriod 0..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legalStatus 0..2 (Complex) legalStatus
URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LegalStatus
Binding: JuridischeStatusCodelijst (2017-12-31T00:00:00) (extensible)
....... coding Σ 1..* Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code Σ 1..1 code Symbol in syntax defined by the system
.... extension:lifeStance 0..* (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LifeStance
Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (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
.... extension:legallyCapableMedicalTreatmentDecisions C 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "legallyCapable"
...... extension:legallyCapableComment 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "legallyCapableComment"
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:BSN Σ 0..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 Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... 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
...... 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
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... Slices for extension Content/Rules for all slices
...... 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
....... 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
... telecom Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the individual
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required)
.... Slices for extension Content/Rules for all slices
..... extension:GeslachtCodelijst 0..1 (Complex) Gender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst
... birthDate Σ 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] ?!Σ 0..1 DeathIndicator/DateOfDeath
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* nl-core-address(3.0.6) AddressInformation
... 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(2.0.6) | nl-core-practitioner(2.0.7)) 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
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.valueCodeableConcept:valueCodeableConcept Base extensible NationaliteitCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:legalStatus.​value[x]:valueCodeableConcept Base extensible JuridischeStatusCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:lifeStance.​value[x]:valueCodeableConcept Base preferred LevensovertuigingCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.identifier:BSN.​use Base required IdentifierUse 📍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]:valueCodeableConcept Base extensible GeslachtCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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
dom-1 error Patient If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from nl-core-patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* nl-core-patient(2.2.4) Patient
... Slices for extension Content/Rules for all slices
.... extension:legallyCapableMedicalTreatmentDecisions C 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
...... extension:legallyCapableComment 0..1 Extension Extension
... identifier 0..* Identifier PatientIdentificationNumber
... name 0..* nl-core-humanname(2.0.10) NameInformation
.... use 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... family
..... Slices for extension Content/Rules for all slices
...... extension:humannameOwnPrefix 0..1 own-prefix Voorvoegsel derived from person's own surname
...... extension:humannameOwnName 0..1 own-name Portion derived from person's own surname
...... extension:humannamePartnerPrefix 0..1 partner-prefix Voorvoegsel derived from person's partner's surname
...... extension:humannamePartnerName 0..1 partner-name Portion derived from person's partner's surname
.... given 0..* string Given
... gender 0..1 code Gender
... birthDate 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.
... address 0..* nl-core-address(3.0.6) AddressInformation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* nl-core-patient(2.2.4) 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
... 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 Extension
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
.... 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 Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... Slices for valueCodeableConcept Content/Rules for all slices
........ valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: NationaliteitCodelijst (2017-12-31T00:00:00) (extensible): Indicates the country of citizenship.
...... extension:period 0..1 Extension Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... Slices for valuePeriod Content/Rules for all slices
........ valuePeriod:valuePeriod 0..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legalStatus 0..2 (Complex) legalStatus
URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LegalStatus
Binding: JuridischeStatusCodelijst (2017-12-31T00:00:00) (extensible)
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..* Coding Code defined by a terminology system
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 1..1 code Symbol in syntax defined by the system
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
.... extension:lifeStance 0..* (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LifeStance
Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (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
.... extension:legallyCapableMedicalTreatmentDecisions C 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
..... 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:legallyCapable 0..1 Extension Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1 uri "legallyCapable"
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1 uri "legallyCapableComment"
....... value[x] 0..1 string LegallyCapableComment
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:system
.... identifier:BSN Σ 0..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 Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
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
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... Slices for valueCode Content/Rules for all slices
....... valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Surname
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:humannameOwnPrefix 0..1 (Complex) Voorvoegsel derived from person's own surname
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) Portion derived from person's own surname
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) Voorvoegsel derived from person's partner's surname
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) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... 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 Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the individual
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:GeslachtCodelijst 0..1 (Complex) Gender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst
.... value 0..1 code Primitive value for code
... birthDate Σ 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] ?!Σ 0..1 DeathIndicator/DateOfDeath
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* nl-core-address(3.0.6) AddressInformation
... maritalStatus 0..1 CodeableConcept MaritalStatus
Binding: BurgerlijkeStaatCodelijst (2017-12-31T00:00:00) (extensible)
... multipleBirth[x] 0..1 MultipleBirthIndicator
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact 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 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2017-12-31T00:00:00) (required)
..... relationship:role 0..* CodeableConcept Role
Binding: RolCodelijst (2017-12-31T00:00:00) (required)
.... name 0..1 nl-core-humanname(2.0.10) NameInformation
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
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
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... Slices for valueCode Content/Rules for all slices
........ valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Surname
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... 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 Extension
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 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... address 0..1 nl-core-address(3.0.6) AddressInformation
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... animal ?!Σ 0..1 BackboneElement This patient is known to be an animal (non-human)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... species Σ 1..1 CodeableConcept E.g. Dog, Cow
Binding: AnimalSpecies (example): The species of an animal.
.... breed Σ 0..1 CodeableConcept E.g. Poodle, Angus
Binding: AnimalBreeds (example): The breed of an animal.
.... genderStatus Σ 0..1 CodeableConcept E.g. Neutered, Intact
Binding: GenderStatus (example): The state of the animal's reproductive organs.
... communication 0..* BackboneElement A list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:languageProficiency 0..* (Complex) Proficiency level of the communication
URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 1..1 Extension Extension
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "type"
........ Slices for value[x] 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCoding 1..1 Coding ​Value of extension
Binding: LanguageAbilityMode|2016-11-11 (extensible)
....... extension:level 1..1 Extension Extension
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "level"
........ Slices for value[x] 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCoding 1..1 Coding ​Value of extension
Binding: LanguageAbilityProficiency|2016-11-11 (extensible)
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency"
..... extension:comment 0..* string Comment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... language 1..1 CodeableConcept CommunicationLanguage
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..1 Reference(nl-core-organization(2.0.6) | nl-core-practitioner(2.0.7)) GeneralPractitioner
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
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
.... 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 Σ 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.

doco 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:valueCodeableConcept Base extensible NationaliteitCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:legalStatus.​value[x]:valueCodeableConcept Base extensible JuridischeStatusCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:lifeStance.​value[x]:valueCodeableConcept Base preferred LevensovertuigingCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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.​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]:valueCodeableConcept Base extensible GeslachtCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.maritalStatus Base extensible BurgerlijkeStaatCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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.2
Patient.contact.relationship:role Base required RolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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.value[x]:valueCoding Base extensible v3 Code System LanguageAbilityMode 📍2016-11-11 FHIR Std.
Patient.communication.​extension:languageProficiency.​extension:level.value[x]: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
dom-1 error Patient If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from nl-core-patient

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* nl-core-patient(2.2.4) 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
.... 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 Extension
....... url 1..1 uri "code"
....... Slices for valueCodeableConcept Content/Rules for all slices
........ valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: NationaliteitCodelijst (2017-12-31T00:00:00) (extensible): Indicates the country of citizenship.
...... extension:period 0..1 Extension Extension
....... url 1..1 uri "period"
....... Slices for valuePeriod Content/Rules for all slices
........ valuePeriod:valuePeriod 0..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legalStatus 0..2 (Complex) legalStatus
URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LegalStatus
Binding: JuridischeStatusCodelijst (2017-12-31T00:00:00) (extensible)
....... coding Σ 1..* Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code Σ 1..1 code Symbol in syntax defined by the system
.... extension:lifeStance 0..* (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LifeStance
Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (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
.... extension:legallyCapableMedicalTreatmentDecisions C 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "legallyCapable"
...... extension:legallyCapableComment 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "legallyCapableComment"
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:BSN Σ 0..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 Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... 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
...... 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
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... Slices for extension Content/Rules for all slices
...... 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
....... 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
... telecom Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the individual
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required)
.... Slices for extension Content/Rules for all slices
..... extension:GeslachtCodelijst 0..1 (Complex) Gender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst
... birthDate Σ 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] ?!Σ 0..1 DeathIndicator/DateOfDeath
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* nl-core-address(3.0.6) AddressInformation
... 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(2.0.6) | nl-core-practitioner(2.0.7)) 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
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.valueCodeableConcept:valueCodeableConcept Base extensible NationaliteitCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:legalStatus.​value[x]:valueCodeableConcept Base extensible JuridischeStatusCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:lifeStance.​value[x]:valueCodeableConcept Base preferred LevensovertuigingCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.identifier:BSN.​use Base required IdentifierUse 📍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]:valueCodeableConcept Base extensible GeslachtCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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
dom-1 error Patient If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from nl-core-patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* nl-core-patient(2.2.4) Patient
... Slices for extension Content/Rules for all slices
.... extension:legallyCapableMedicalTreatmentDecisions C 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
...... extension:legallyCapableComment 0..1 Extension Extension
... identifier 0..* Identifier PatientIdentificationNumber
... name 0..* nl-core-humanname(2.0.10) NameInformation
.... use 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... family
..... Slices for extension Content/Rules for all slices
...... extension:humannameOwnPrefix 0..1 own-prefix Voorvoegsel derived from person's own surname
...... extension:humannameOwnName 0..1 own-name Portion derived from person's own surname
...... extension:humannamePartnerPrefix 0..1 partner-prefix Voorvoegsel derived from person's partner's surname
...... extension:humannamePartnerName 0..1 partner-name Portion derived from person's partner's surname
.... given 0..* string Given
... gender 0..1 code Gender
... birthDate 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.
... address 0..* nl-core-address(3.0.6) AddressInformation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* nl-core-patient(2.2.4) 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
... 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 Extension
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
.... 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 Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "code"
....... Slices for valueCodeableConcept Content/Rules for all slices
........ valueCodeableConcept:valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: NationaliteitCodelijst (2017-12-31T00:00:00) (extensible): Indicates the country of citizenship.
...... extension:period 0..1 Extension Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... Slices for valuePeriod Content/Rules for all slices
........ valuePeriod:valuePeriod 0..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legalStatus 0..2 (Complex) legalStatus
URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
..... Slices for value[x] 0..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LegalStatus
Binding: JuridischeStatusCodelijst (2017-12-31T00:00:00) (extensible)
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..* Coding Code defined by a terminology system
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 1..1 code Symbol in syntax defined by the system
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
.... extension:lifeStance 0..* (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept LifeStance
Binding: LevensovertuigingCodelijst (2017-12-31T00:00:00) (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
.... extension:legallyCapableMedicalTreatmentDecisions C 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
..... 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:legallyCapable 0..1 Extension Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1 uri "legallyCapable"
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1 uri "legallyCapableComment"
....... value[x] 0..1 string LegallyCapableComment
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:system
.... identifier:BSN Σ 0..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 Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
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
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... Slices for valueCode Content/Rules for all slices
....... valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Surname
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:humannameOwnPrefix 0..1 (Complex) Voorvoegsel derived from person's own surname
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) Portion derived from person's own surname
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) Voorvoegsel derived from person's partner's surname
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) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... 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 Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the individual
... gender Σ 0..1 code Gender
Binding: AdministrativeGender (required)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:GeslachtCodelijst 0..1 (Complex) Gender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/code-specification"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: GeslachtCodelijst (2017-12-31T00:00:00) (extensible): GeslachtCodelijst
.... value 0..1 code Primitive value for code
... birthDate Σ 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] ?!Σ 0..1 DeathIndicator/DateOfDeath
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* nl-core-address(3.0.6) AddressInformation
... maritalStatus 0..1 CodeableConcept MaritalStatus
Binding: BurgerlijkeStaatCodelijst (2017-12-31T00:00:00) (extensible)
... multipleBirth[x] 0..1 MultipleBirthIndicator
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact 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 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2017-12-31T00:00:00) (required)
..... relationship:role 0..* CodeableConcept Role
Binding: RolCodelijst (2017-12-31T00:00:00) (required)
.... name 0..1 nl-core-humanname(2.0.10) NameInformation
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
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
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... Slices for valueCode Content/Rules for all slices
........ valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Surname
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... 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 Extension
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 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... address 0..1 nl-core-address(3.0.6) AddressInformation
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... animal ?!Σ 0..1 BackboneElement This patient is known to be an animal (non-human)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... species Σ 1..1 CodeableConcept E.g. Dog, Cow
Binding: AnimalSpecies (example): The species of an animal.
.... breed Σ 0..1 CodeableConcept E.g. Poodle, Angus
Binding: AnimalBreeds (example): The breed of an animal.
.... genderStatus Σ 0..1 CodeableConcept E.g. Neutered, Intact
Binding: GenderStatus (example): The state of the animal's reproductive organs.
... communication 0..* BackboneElement A list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:languageProficiency 0..* (Complex) Proficiency level of the communication
URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 1..1 Extension Extension
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "type"
........ Slices for value[x] 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCoding 1..1 Coding ​Value of extension
Binding: LanguageAbilityMode|2016-11-11 (extensible)
....... extension:level 1..1 Extension Extension
........ id 0..1 string xml:id (or equivalent in JSON)
........ extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
........ url 1..1 uri "level"
........ Slices for value[x] 1..1 Coding Value of extension
Slice: Unordered, Closed by type:$this
......... value[x]:valueCoding 1..1 Coding ​Value of extension
Binding: LanguageAbilityProficiency|2016-11-11 (extensible)
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/patient-proficiency"
..... extension:comment 0..* string Comment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... language 1..1 CodeableConcept CommunicationLanguage
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..1 Reference(nl-core-organization(2.0.6) | nl-core-practitioner(2.0.7)) GeneralPractitioner
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
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
.... 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 Σ 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.

doco 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:valueCodeableConcept Base extensible NationaliteitCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:legalStatus.​value[x]:valueCodeableConcept Base extensible JuridischeStatusCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.extension:lifeStance.​value[x]:valueCodeableConcept Base preferred LevensovertuigingCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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.​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]:valueCodeableConcept Base extensible GeslachtCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
Patient.maritalStatus Base extensible BurgerlijkeStaatCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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.2
Patient.contact.relationship:role Base required RolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
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.value[x]:valueCoding Base extensible v3 Code System LanguageAbilityMode 📍2016-11-11 FHIR Std.
Patient.communication.​extension:languageProficiency.​extension:level.value[x]: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
dom-1 error Patient If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from nl-core-patient

 

Other representations of profile: CSV, Excel, Schematron