RIVO Noord Zorgviewer MVP2 Implementation Guide
0.2.1 - CI build Netherlands flag

RIVO Noord Zorgviewer MVP2 Implementation Guide - Local Development build (v0.2.1). See the Directory of published versions

Resource Profile: Patient

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/Patient Version: 0.2.1
Draft as of 2023-03-22 Computable Name: Patient

The minimal Patient for the Zorgviewer

Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic en Chipsoft. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Bronsysteem herkennen

De Zorgviewer-backend ZOU na bevragen van het bronsysteem aan elk resultaat resource een meta-tag MOETEN toevoegen met de VEKTIZ code van de zorgaanbieder, zodat dit kan worden gebruikt in de presentatie in de Zorgviewer-frontend.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

{ ...
  "meta": {
    "tag": [
      { "system": "http://hl7.nl/fhir/zorgviewer-ig/bronsysteem-zorgaanbieder",
        "code": "06020101",
        "display": "UMCG"
      } ] }
  ... }

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from nl-core-patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*nl-core-patientPatient
... identifier:BSN S1..1IdentifierBSN
... name SC1..*nl-core-humannameNameInformation
zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.
zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.
... gender S0..1codeGender

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
zv-pat-1errorPatient.nameEither 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-2best practicePatient.nameTo be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.
: text.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*nl-core-patientPatient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... preferredPharmacy 0..1Reference(nl-core-organization)References a patient's preferered pharmacy
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy
... nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:code 0..1ExtensionExtension
..... url 1..1uri"code"
..... valueCodeableConcept:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship.

.... extension:period 0..1ExtensionExtension
..... url 1..1uri"period"
..... valuePeriod:valuePeriod 0..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLegalStatus
Binding: JuridischeStatusCodelijst (extensible)
...... coding Σ1..*CodingCode defined by a terminology system
....... system Σ1..1uriIdentity of the terminology system
....... code Σ1..1codeSymbol in syntax defined by the system
... lifeStance 0..*CodeableConceptOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst


.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst

...... coding Σ1..1CodingCode defined by a terminology system
....... system Σ1..1uriIdentity of the terminology system
....... code Σ1..1codeSymbol in syntax defined by the system
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierPatientIdentificationNumber
Slice: Unordered, Open by value:system
.... identifier:BSN SΣ1..1IdentifierBSN
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
..... value Σ1..1stringBSN (Burgerservicenummer (Dutch person identification number))
Example General: 123456
Example Example of a burgerservicenummer: 123456782
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SC1..*nl-core-humannameNameInformation
zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.
zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
.... humannameAssemblyOrder 0..*codePreferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
..... valueCode:valueCode 0..1codeValue of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

... gender SΣ0..1codeGender
Binding: AdministrativeGender (required)
.... GeslachtCodelijst 0..1CodeableConceptGender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
..... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/code-specification"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: GeslachtCodelijst (extensible): GeslachtCodelijst

... birthDate SΣ0..1datePatients 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..1DeathIndicator/DateOfDeath
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address C0..*nl-core-addressAddressInformation

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"],"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"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
... animal ?!Σ0..1BackboneElementThis patient is known to be an animal (non-human)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example): The species of an animal.

... generalPractitioner 0..1Reference(nl-core-organization | nl-core-practitioner)GeneralPractitioner
.... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet
Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConceptextensibleNationaliteitCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.16.32)
Patient.extension:legalStatus.value[x]:valueCodeableConceptextensibleJuridischeStatusCodelijst
Patient.extension:lifeStance.value[x]:valueCodeableConceptpreferredLevensovertuigingCodelijst
Patient.identifier:BSN.userequiredIdentifierUse
Patient.name.extension:humannameAssemblyOrder.valueCode:valueCoderequiredHumanNameAssemblyOrder
Patient.name.userequiredNameUse
Patient.genderrequiredAdministrativeGender
Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConceptextensibleGeslachtCodelijst
Patient.animal.speciesexampleAnimalSpecies
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPatientIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorPatient.nameif 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-2errorPatient.nameif 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-partserrorPatient.addressAddress.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value
: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address
zv-pat-1errorPatient.nameEither 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-2best practicePatient.nameTo be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.
: text.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*nl-core-patientPatient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... preferredPharmacy 0..1Reference(nl-core-organization)References a patient's preferered pharmacy
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy
... nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code 0..1ExtensionExtension
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"code"
..... valueCodeableConcept:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship.

.... extension:period 0..1ExtensionExtension
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"period"
..... valuePeriod:valuePeriod 0..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... legalStatus 0..2CodeableConceptlegalStatus
URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLegalStatus
Binding: JuridischeStatusCodelijst (extensible)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
... lifeStance 0..*CodeableConceptOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst

...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierPatientIdentificationNumber
Slice: Unordered, Open by value:system
.... identifier:BSN SΣ1..1IdentifierBSN
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
..... value Σ1..1stringBSN (Burgerservicenummer (Dutch person identification number))
Example General: 123456
Example Example of a burgerservicenummer: 123456782
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SC1..*nl-core-humannameNameInformation
zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.
zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... humannameAssemblyOrder 0..*codePreferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
..... valueCode:valueCode 0..1codeValue of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringSurname
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... humannameOwnPrefix 0..1stringPrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
...... valueString:valueString 0..1stringValue of extension
..... humannameOwnName 0..1stringOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-name"
...... valueString:valueString 0..1stringValue of extension
..... humannamePartnerPrefix 0..1stringPrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
...... valueString:valueString 0..1stringValue of extension
..... humannamePartnerName 0..1stringLastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
...... valueString:valueString 0..1stringValue of extension
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... given Σ0..*stringGiven
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... iso21090EnQualifier 0..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
...... valueCode:valueCode 0..1codeValue 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..1stringPrimitive value for string
Max Length: 1048576
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom C0..*nl-core-contactpointContactInformation

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..1codeGender
Binding: AdministrativeGender (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... GeslachtCodelijst 0..1CodeableConceptGender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/code-specification"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: GeslachtCodelijst (extensible): GeslachtCodelijst

.... value 0..1codePrimitive value for code
... birthDate SΣ0..1datePatients 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..1DeathIndicator/DateOfDeath
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address C0..*nl-core-addressAddressInformation

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"],"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"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
... maritalStatus 0..1CodeableConceptMaritalStatus
Binding: BurgerlijkeStaatCodelijst (extensible)
... multipleBirth[x] 0..1MultipleBirthIndicator
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementContactPerson
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... Slices for relationship 0..*CodeableConceptThe 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..*CodeableConceptRelationship
Binding: RelatieCodelijst (required)
..... relationship:role 0..*CodeableConceptRole
Binding: RolCodelijst (required)
.... name C0..1nl-core-humannameNameInformation
Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... humannameAssemblyOrder 0..*codePreferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... valueCode:valueCode 0..1codeValue of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringSurname
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... humannameOwnPrefix 0..1stringPrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
....... valueString:valueString 0..1stringValue of extension
...... humannameOwnName 0..1stringOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-name"
....... valueString:valueString 0..1stringValue of extension
...... humannamePartnerPrefix 0..1stringPrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
....... valueString:valueString 0..1stringValue of extension
...... humannamePartnerName 0..1stringLastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
....... valueString:valueString 0..1stringValue of extension
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... given Σ0..*stringGiven
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... iso21090EnQualifier 0..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
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


....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... valueCode:valueCode 0..1codeValue 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..1stringPrimitive value for string
Max Length: 1048576
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom C0..*nl-core-contactpointContactInformation

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 C0..1nl-core-addressAddressInformation
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"],"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"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... animal ?!Σ0..1BackboneElementThis patient is known to be an animal (non-human)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example): The species of an animal.

.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example): The breed of an animal.

.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... communication 0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... languageProficiency 0..*(Complex)Proficiency level of the communication
URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension:type 1..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"type"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 1..1CodingValue of extension
Binding: LanguageAbilityMode (extensible)
..... extension:level 1..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"level"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 1..1CodingValue of extension
Binding: LanguageAbilityProficiency (extensible)
..... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/patient-proficiency"
.... comment 0..*stringComment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptCommunicationLanguage
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..1Reference(nl-core-organization | nl-core-practitioner)GeneralPractitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet
Patient.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConceptextensibleNationaliteitCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.16.32)
Patient.extension:legalStatus.value[x]:valueCodeableConceptextensibleJuridischeStatusCodelijst
Patient.extension:lifeStance.value[x]:valueCodeableConceptpreferredLevensovertuigingCodelijst
Patient.identifier:BSN.userequiredIdentifierUse
Patient.identifier:BSN.typeextensibleIdentifier Type Codes
Patient.name.extension:humannameAssemblyOrder.valueCode:valueCoderequiredHumanNameAssemblyOrder
Patient.name.userequiredNameUse
Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
Patient.genderrequiredAdministrativeGender
Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConceptextensibleGeslachtCodelijst
Patient.maritalStatusextensibleBurgerlijkeStaatCodelijst
Patient.contact.relationshipextensiblev2 Contact Role
Patient.contact.relationship:relationshiprequiredRelatieCodelijst
Patient.contact.relationship:rolerequiredRolCodelijst
Patient.contact.name.extension:humannameAssemblyOrder.valueCode:valueCoderequiredHumanNameAssemblyOrder
Patient.contact.name.userequiredNameUse
Patient.contact.name.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
Patient.contact.genderrequiredAdministrativeGender
Patient.animal.speciesexampleAnimalSpecies
Patient.animal.breedexampleAnimalBreeds
Patient.animal.genderStatusexampleGenderStatus
Patient.communication.extension:languageProficiency.extension:type.value[x]:valueCodingextensiblev3 Code System LanguageAbilityMode
Patient.communication.extension:languageProficiency.extension:level.value[x]:valueCodingextensiblev3 Code System LanguageAbilityProficiency
Patient.communication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorPatient.name, Patient.contact.nameif 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-2errorPatient.name, Patient.contact.nameif 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-partserrorPatient.address, Patient.contact.addressAddress.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value
: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address
pat-1errorPatient.contactSHALL 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-1errorPatient.nameEither 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-2best practicePatient.nameTo 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: 4 elements

Differential View

This structure is derived from nl-core-patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*nl-core-patientPatient
... identifier:BSN S1..1IdentifierBSN
... name SC1..*nl-core-humannameNameInformation
zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.
zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.
... gender S0..1codeGender

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
zv-pat-1errorPatient.nameEither 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-2best practicePatient.nameTo be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.
: text.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*nl-core-patientPatient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... preferredPharmacy 0..1Reference(nl-core-organization)References a patient's preferered pharmacy
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy
... nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:code 0..1ExtensionExtension
..... url 1..1uri"code"
..... valueCodeableConcept:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship.

.... extension:period 0..1ExtensionExtension
..... url 1..1uri"period"
..... valuePeriod:valuePeriod 0..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLegalStatus
Binding: JuridischeStatusCodelijst (extensible)
...... coding Σ1..*CodingCode defined by a terminology system
....... system Σ1..1uriIdentity of the terminology system
....... code Σ1..1codeSymbol in syntax defined by the system
... lifeStance 0..*CodeableConceptOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst


.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst

...... coding Σ1..1CodingCode defined by a terminology system
....... system Σ1..1uriIdentity of the terminology system
....... code Σ1..1codeSymbol in syntax defined by the system
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierPatientIdentificationNumber
Slice: Unordered, Open by value:system
.... identifier:BSN SΣ1..1IdentifierBSN
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
..... value Σ1..1stringBSN (Burgerservicenummer (Dutch person identification number))
Example General: 123456
Example Example of a burgerservicenummer: 123456782
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SC1..*nl-core-humannameNameInformation
zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.
zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
.... humannameAssemblyOrder 0..*codePreferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
..... valueCode:valueCode 0..1codeValue of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

... gender SΣ0..1codeGender
Binding: AdministrativeGender (required)
.... GeslachtCodelijst 0..1CodeableConceptGender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
..... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/code-specification"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: GeslachtCodelijst (extensible): GeslachtCodelijst

... birthDate SΣ0..1datePatients 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..1DeathIndicator/DateOfDeath
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address C0..*nl-core-addressAddressInformation

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"],"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"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
... animal ?!Σ0..1BackboneElementThis patient is known to be an animal (non-human)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example): The species of an animal.

... generalPractitioner 0..1Reference(nl-core-organization | nl-core-practitioner)GeneralPractitioner
.... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet
Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConceptextensibleNationaliteitCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.16.32)
Patient.extension:legalStatus.value[x]:valueCodeableConceptextensibleJuridischeStatusCodelijst
Patient.extension:lifeStance.value[x]:valueCodeableConceptpreferredLevensovertuigingCodelijst
Patient.identifier:BSN.userequiredIdentifierUse
Patient.name.extension:humannameAssemblyOrder.valueCode:valueCoderequiredHumanNameAssemblyOrder
Patient.name.userequiredNameUse
Patient.genderrequiredAdministrativeGender
Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConceptextensibleGeslachtCodelijst
Patient.animal.speciesexampleAnimalSpecies
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPatientIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorPatient.nameif 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-2errorPatient.nameif 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-partserrorPatient.addressAddress.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value
: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address
zv-pat-1errorPatient.nameEither 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-2best practicePatient.nameTo be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.
: text.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*nl-core-patientPatient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... preferredPharmacy 0..1Reference(nl-core-organization)References a patient's preferered pharmacy
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy
... nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code 0..1ExtensionExtension
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"code"
..... valueCodeableConcept:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: NationaliteitCodelijst (extensible): Indicates the country of citizenship.

.... extension:period 0..1ExtensionExtension
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"period"
..... valuePeriod:valuePeriod 0..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... legalStatus 0..2CodeableConceptlegalStatus
URL: http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus
Binding: JuridischeStatusCodelijst (preferred): LegalStatusCodelist


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus"
.... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLegalStatus
Binding: JuridischeStatusCodelijst (extensible)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..*CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
... lifeStance 0..*CodeableConceptOptional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst


.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance"
.... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptLifeStance
Binding: LevensovertuigingCodelijst (preferred): LevensovertuigingCodelijst

...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ1..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierPatientIdentificationNumber
Slice: Unordered, Open by value:system
.... identifier:BSN SΣ1..1IdentifierBSN
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
..... value Σ1..1stringBSN (Burgerservicenummer (Dutch person identification number))
Example General: 123456
Example Example of a burgerservicenummer: 123456782
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SC1..*nl-core-humannameNameInformation
zv-pat-1: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present.
zv-pat-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.

Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... humannameAssemblyOrder 0..*codePreferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
..... valueCode:valueCode 0..1codeValue of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

.... text Σ0..1stringText representation of the full name
.... family Σ0..1stringSurname
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... humannameOwnPrefix 0..1stringPrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
...... valueString:valueString 0..1stringValue of extension
..... humannameOwnName 0..1stringOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-name"
...... valueString:valueString 0..1stringValue of extension
..... humannamePartnerPrefix 0..1stringPrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
...... valueString:valueString 0..1stringValue of extension
..... humannamePartnerName 0..1stringLastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
...... valueString:valueString 0..1stringValue of extension
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... given Σ0..*stringGiven
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... iso21090EnQualifier 0..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
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


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
...... valueCode:valueCode 0..1codeValue 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..1stringPrimitive value for string
Max Length: 1048576
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom C0..*nl-core-contactpointContactInformation

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..1codeGender
Binding: AdministrativeGender (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... GeslachtCodelijst 0..1CodeableConceptGender
URL: http://nictiz.nl/fhir/StructureDefinition/code-specification
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/code-specification"
..... Slices for value[x] 1..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: GeslachtCodelijst (extensible): GeslachtCodelijst

.... value 0..1codePrimitive value for code
... birthDate SΣ0..1datePatients 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..1DeathIndicator/DateOfDeath
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address C0..*nl-core-addressAddressInformation

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"],"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"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
... maritalStatus 0..1CodeableConceptMaritalStatus
Binding: BurgerlijkeStaatCodelijst (extensible)
... multipleBirth[x] 0..1MultipleBirthIndicator
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementContactPerson
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... Slices for relationship 0..*CodeableConceptThe 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..*CodeableConceptRelationship
Binding: RelatieCodelijst (required)
..... relationship:role 0..*CodeableConceptRole
Binding: RolCodelijst (required)
.... name C0..1nl-core-humannameNameInformation
Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]}
Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"}
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... humannameAssemblyOrder 0..*codePreferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... valueCode:valueCode 0..1codeValue of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name

..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringSurname
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... humannameOwnPrefix 0..1stringPrefixOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
....... valueString:valueString 0..1stringValue of extension
...... humannameOwnName 0..1stringOwnName
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-own-name"
....... valueString:valueString 0..1stringValue of extension
...... humannamePartnerPrefix 0..1stringPrefixSurname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
....... valueString:valueString 0..1stringValue of extension
...... humannamePartnerName 0..1stringLastNamePartner
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
....... valueString:valueString 0..1stringValue of extension
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... given Σ0..*stringGiven
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... iso21090EnQualifier 0..1codeLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
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


....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... valueCode:valueCode 0..1codeValue 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..1stringPrimitive value for string
Max Length: 1048576
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom C0..*nl-core-contactpointContactInformation

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 C0..1nl-core-addressAddressInformation
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"],"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"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... animal ?!Σ0..1BackboneElementThis patient is known to be an animal (non-human)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example): The species of an animal.

.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreeds (example): The breed of an animal.

.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... communication 0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... languageProficiency 0..*(Complex)Proficiency level of the communication
URL: http://nictiz.nl/fhir/StructureDefinition/patient-proficiency
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension:type 1..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"type"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 1..1CodingValue of extension
Binding: LanguageAbilityMode (extensible)
..... extension:level 1..1ExtensionExtension
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"level"
...... Slices for value[x] 1..1CodingValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCoding 1..1CodingValue of extension
Binding: LanguageAbilityProficiency (extensible)
..... url 1..1uri"http://nictiz.nl/fhir/StructureDefinition/patient-proficiency"
.... comment 0..*stringComment
URL: http://nictiz.nl/fhir/StructureDefinition/Comment
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptCommunicationLanguage
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..1Reference(nl-core-organization | nl-core-practitioner)GeneralPractitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitionerRole 0..1Reference(nl-core-practitionerrole)Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet
Patient.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:nationality.extension:code.valueCodeableConcept:valueCodeableConceptextensibleNationaliteitCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.16.32)
Patient.extension:legalStatus.value[x]:valueCodeableConceptextensibleJuridischeStatusCodelijst
Patient.extension:lifeStance.value[x]:valueCodeableConceptpreferredLevensovertuigingCodelijst
Patient.identifier:BSN.userequiredIdentifierUse
Patient.identifier:BSN.typeextensibleIdentifier Type Codes
Patient.name.extension:humannameAssemblyOrder.valueCode:valueCoderequiredHumanNameAssemblyOrder
Patient.name.userequiredNameUse
Patient.name.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
Patient.genderrequiredAdministrativeGender
Patient.gender.extension:GeslachtCodelijst.value[x]:valueCodeableConceptextensibleGeslachtCodelijst
Patient.maritalStatusextensibleBurgerlijkeStaatCodelijst
Patient.contact.relationshipextensiblev2 Contact Role
Patient.contact.relationship:relationshiprequiredRelatieCodelijst
Patient.contact.relationship:rolerequiredRolCodelijst
Patient.contact.name.extension:humannameAssemblyOrder.valueCode:valueCoderequiredHumanNameAssemblyOrder
Patient.contact.name.userequiredNameUse
Patient.contact.name.given.extension:iso21090EnQualifier.valueCode:valueCoderequiredEntityNamePartQualifier
Patient.contact.genderrequiredAdministrativeGender
Patient.animal.speciesexampleAnimalSpecies
Patient.animal.breedexampleAnimalBreeds
Patient.animal.genderStatusexampleGenderStatus
Patient.communication.extension:languageProficiency.extension:type.value[x]:valueCodingextensiblev3 Code System LanguageAbilityMode
Patient.communication.extension:languageProficiency.extension:level.value[x]:valueCodingextensiblev3 Code System LanguageAbilityProficiency
Patient.communication.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-humanname-1errorPatient.name, Patient.contact.nameif 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-2errorPatient.name, Patient.contact.nameif 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-partserrorPatient.address, Patient.contact.addressAddress.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value
: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))
This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address
pat-1errorPatient.contactSHALL 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-1errorPatient.nameEither 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-2best practicePatient.nameTo 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: 4 elements

 

Other representations of profile: CSV, Excel, Schematron