PLUGIN
0.1.0-ci - ci-build NL

PLUGIN - Local Development build (v0.1.0-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Patient

Official URL: https://plugin.healthcare/fhir/StructureDefinition/plugin-patient Version: 0.1.0-ci
Draft as of 2025-01-16 Computable Name: PluginPatient

Copyright/Legal: Used by permission of the PLUGIN team, all rights reserved Creative Commons License

Describes the Patient resource as used by the Dutch PLUGIN project. Inherits from nl-core-Patient.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* NlcorePatient Patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... nationality N 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for extension Content/Rules for all slices
...... extension:code N 0..1 Extension Nationality Code
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension N 0..0
....... url 1..1 uri "code"
....... value[x] N 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
ele-1: All FHIR elements must have a @value or children
...... extension:period N 0..1 Extension Nationality Period
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension N 0..0
....... url 1..1 uri "period"
....... value[x] N 1..1 Period Value of extension
ele-1: All FHIR elements must have a @value or children
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:bsn ΣN 0..* Identifier An identifier for this patient
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
.... identifier:patientnummer SΣ 1..1 Identifier Patientnummer zoals gebruikt in het EPD
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
..... value Σ 1..1 string Patientnummer
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
ele-1: All FHIR elements must have a @value or children
... Slices for name SΣ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... name:nameInformation SΣC 0..2 NlcoreNameInformation NameInformation
ele-1: All FHIR elements must have a @value or children
zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
..... Slices for extension Content/Rules for all slices
...... nameUsage N 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] N 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.


ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
..... family SΣC 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
nl-core-NameInformation-02: If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
...... Slices for extension Content/Rules for all slices
....... prefix N 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] N 1..1 string Prefix
ele-1: All FHIR elements must have a @value or children
....... lastName N 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] N 1..1 string LastName
ele-1: All FHIR elements must have a @value or children
....... partnerPrefix N 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] N 1..1 string PartnerPrefix
ele-1: All FHIR elements must have a @value or children
....... partnerLastName N 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] N 1..1 string PartnerLastName
ele-1: All FHIR elements must have a @value or children
..... given ΣC 0..* string FirstName / Initial
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
...... Slices for extension N 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... givenOrInitial N 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
ele-1: All FHIR elements must have a @value or children
... Slices for telecom ΣCN 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
... gender SΣ 1..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.


ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... genderCodelist N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
... birthDate SΣ 1..1 date DateOfBirth
ele-1: All FHIR elements must have a @value or children
... Slices for deceased[x] ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
ele-1: All FHIR elements must have a @value or children
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime DateOfDeath
ele-1: All FHIR elements must have a @value or children
... address Σ 0..* NlcoreAddressInformation AddressInformation
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... postalCode SΣ 0..1 string Postcode
ele-1: All FHIR elements must have a @value or children
Example General: 9132
... Slices for multipleBirth[x] N 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean N 0..1 boolean MultipleBirthIndicator
ele-1: All FHIR elements must have a @value or children
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.extension:nationality.extension:code.value[x]extensibleNationaliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.identifier:patientnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:patientnummer.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
from the FHIR Standard
Patient.name:nameInformation.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-NameInformation-01warningPatient.name:nameInformationIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPatient.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
ref-1errorPatient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1errorPatient.name:nameInformationIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPatient.name:nameInformationIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcorePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient NlcorePatient
... identifier S 1..* Identifier PatientIdentificationNumber
... Slices for identifier Content/Rules for all slices
.... identifier:patientnummer S 1..1 Identifier Patientnummer zoals gebruikt in het EPD
Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... type 1..1 CodeableConcept Description of identifier
..... value 1..1 string Patientnummer
... name S 0..* HumanName NameInformation / PayerName
.... name:nameInformation S 0..2 NlcoreNameInformation NameInformation
..... family S 0..1 string Family name (often called 'Surname')
... gender S 1..1 code Gender
... birthDate S 1..1 date DateOfBirth
... deceased[x] S 0..1 dateTime Indicates if the individual is deceased or not
... address
.... use S 0..1 code AddressType
.... postalCode S 0..1 string Postcode

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* NlcorePatient Patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... nationality N 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:code N 0..1 Extension Nationality Code
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "code"
....... value[x] N 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
...... extension:period N 0..1 Extension Nationality Period
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "period"
....... value[x] N 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 1..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:$this
.... identifier:bsn ΣN 0..* Identifier An identifier for this patient

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:patientnummer SΣ 1..1 Identifier Patientnummer zoals gebruikt in het EPD

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Patientnummer
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation SΣC 0..2 NlcoreNameInformation NameInformation
zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... nameUsage N 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] N 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.

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


Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
..... family SΣC 0..1 string Family name (often called 'Surname')
nl-core-NameInformation-02: If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... prefix N 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] N 1..1 string Prefix
....... lastName N 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] N 1..1 string LastName
....... partnerPrefix N 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] N 1..1 string PartnerPrefix
....... partnerLastName N 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] N 1..1 string PartnerLastName
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given ΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... givenOrInitial N 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
per-1: If present, start SHALL have a lower value than end
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
... Slices for telecom ΣCN 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
cpt-2: A system is required if a value is provided.
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
cpt-2: A system is required if a value is provided.
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
cpt-2: A system is required if a value is provided.
... gender SΣ 1..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.

.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... genderCodelist N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] N 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (required): GeslachtCodelijst

.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣ 1..1 date DateOfBirth
... Slices for deceased[x] ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime DateOfDeath
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
.... use ?!SΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.


Example General: home
.... type Σ 0..1 code AddressType
Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... streetName N 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] N 1..1 string Street
...... houseNumber N 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] N 1..1 string HouseNumber
...... houseNumberLetter-houseNumberAddition N 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] N 1..1 string HouseNumberLetter / HouseNumberAddition
...... houseNumberIndication N 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] CN 1..1 string HouseNumberIndication
houseNumberIndication: Must have value 'by' or 'to'
...... additionalInformation N 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] N 1..1 string AdditionalInformation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string PlaceOfResidence
Example General: Erewhon
.... district Σ 0..1 string Municipality
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postcode
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... countryCode N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
....... value[x] N 0..1 CodeableConcept Country
Binding: LandCodelijsten (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... period ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept MaritalStatus
Binding: BurgerlijkeStaatCodelijst (required): BurgerlijkeStaatCodelijst

... Slices for multipleBirth[x] N 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean N 0..1 boolean MultipleBirthIndicator
... photo C 0..* Attachment Image of the patient
att-1: If the Attachment has data, it SHALL have a contentType
... contact C 0..* BackboneElement Contact
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contactPerson N 0..1 (Complex) This contact may have further details in this RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] N 1..1 Reference(RelatedPerson | nl core ContactPerson) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for relationship N 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:$this
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... relationship:role N 0..* CodeableConcept Role
Binding: RolCodelijst (required): RolCodelijst


..... relationship:relationship N 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (required): RelatieCodelijst


.... name C 0..1 NlcoreNameInformation NameInformation
zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
.... Slices for telecom CN 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
cpt-2: A system is required if a value is provided.
..... telecom:telephoneNumbers CN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
cpt-2: A system is required if a value is provided.
..... telecom:emailAddresses CN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
cpt-2: A system is required if a value is provided.
.... address 0..1 NlcoreAddressInformation AddressInformation
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
ref-1: SHALL have a contained resource if a local reference is provided
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
per-1: If present, start SHALL have a lower value than end
... communication 0..* BackboneElement LanguageProficiency
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... languageControl N 0..* (Complex) LanguageControlListening / LanguageControlSpeaking / LanguageControlReading
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:level N 1..1 Extension The proficiency level of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "level"
........ value[x] N 1..1 Coding Value of extension
Binding: LanguageAbilityProficiency (required): The proficiency level for the communication.

....... extension:type N 1..1 Extension The proficiency type of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "type"
........ value[x] N 1..1 Coding Value of extension
Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.

...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-proficiency"
..... communicationDetails N 0..* CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails
Binding: CommunicatieBijzonderhedenCodelijst (extensible)
..... comment N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
...... value[x] N 0..1 string Comment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept CommunicationLanguage
Binding: CommunicatieTaalCodelijst (required): CommunicatieTaalCodelijst

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* PatternNlCoreHealthProfessionalReference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole) A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:nationality.extension:code.value[x]extensibleNationaliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.identifier:patientnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:patientnummer.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
from the FHIR Standard
Patient.name:nameInformation.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.gender.extension:genderCodelist.value[x]requiredGeslachtCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.country.extension:countryCode.value[x]requiredLandCodelijsten
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000
Patient.maritalStatusrequiredBurgerlijkeStaatCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.relationship:rolerequiredRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
Patient.contact.relationship:relationshiprequiredRelatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.extension:languageControl.extension:level.value[x]requiredLanguageAbilityProficiency
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:languageControl.extension:type.value[x]preferredLanguageAbilityMode
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.languagerequiredCommunicatieTaalCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorPatient.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorPatient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
houseNumberIndicationerrorPatient.address.line.extension:houseNumberIndication.value[x]Must have value 'by' or 'to'
: $this in ('by' | 'to')
nl-core-NameInformation-01warningPatient.name:nameInformation, Patient.contact.nameIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPatient.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
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()
per-1errorPatient.name:nameInformation.period, Patient.address.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorPatient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1errorPatient.name:nameInformation, Patient.contact.nameIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPatient.name:nameInformation, Patient.contact.nameIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcorePatient

Summary

Mandatory: 6 elements
Must-Support: 10 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* NlcorePatient Patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... nationality N 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... Slices for extension Content/Rules for all slices
...... extension:code N 0..1 Extension Nationality Code
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension N 0..0
....... url 1..1 uri "code"
....... value[x] N 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
ele-1: All FHIR elements must have a @value or children
...... extension:period N 0..1 Extension Nationality Period
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension N 0..0
....... url 1..1 uri "period"
....... value[x] N 1..1 Period Value of extension
ele-1: All FHIR elements must have a @value or children
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:bsn ΣN 0..* Identifier An identifier for this patient
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
.... identifier:patientnummer SΣ 1..1 Identifier Patientnummer zoals gebruikt in het EPD
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
..... value Σ 1..1 string Patientnummer
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
ele-1: All FHIR elements must have a @value or children
... Slices for name SΣ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... name:nameInformation SΣC 0..2 NlcoreNameInformation NameInformation
ele-1: All FHIR elements must have a @value or children
zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
..... Slices for extension Content/Rules for all slices
...... nameUsage N 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] N 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.


ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
..... family SΣC 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
nl-core-NameInformation-02: If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
...... Slices for extension Content/Rules for all slices
....... prefix N 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] N 1..1 string Prefix
ele-1: All FHIR elements must have a @value or children
....... lastName N 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] N 1..1 string LastName
ele-1: All FHIR elements must have a @value or children
....... partnerPrefix N 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] N 1..1 string PartnerPrefix
ele-1: All FHIR elements must have a @value or children
....... partnerLastName N 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] N 1..1 string PartnerLastName
ele-1: All FHIR elements must have a @value or children
..... given ΣC 0..* string FirstName / Initial
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
...... Slices for extension N 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... givenOrInitial N 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
ele-1: All FHIR elements must have a @value or children
... Slices for telecom ΣCN 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
... gender SΣ 1..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.


ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... genderCodelist N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
... birthDate SΣ 1..1 date DateOfBirth
ele-1: All FHIR elements must have a @value or children
... Slices for deceased[x] ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
ele-1: All FHIR elements must have a @value or children
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime DateOfDeath
ele-1: All FHIR elements must have a @value or children
... address Σ 0..* NlcoreAddressInformation AddressInformation
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... postalCode SΣ 0..1 string Postcode
ele-1: All FHIR elements must have a @value or children
Example General: 9132
... Slices for multipleBirth[x] N 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean N 0..1 boolean MultipleBirthIndicator
ele-1: All FHIR elements must have a @value or children
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.extension:nationality.extension:code.value[x]extensibleNationaliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.identifier:patientnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:patientnummer.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
from the FHIR Standard
Patient.name:nameInformation.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPatient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-NameInformation-01warningPatient.name:nameInformationIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPatient.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
ref-1errorPatient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1errorPatient.name:nameInformationIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPatient.name:nameInformationIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Differential View

This structure is derived from NlcorePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient NlcorePatient
... identifier S 1..* Identifier PatientIdentificationNumber
... Slices for identifier Content/Rules for all slices
.... identifier:patientnummer S 1..1 Identifier Patientnummer zoals gebruikt in het EPD
Required Pattern: At least the following
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
..... type 1..1 CodeableConcept Description of identifier
..... value 1..1 string Patientnummer
... name S 0..* HumanName NameInformation / PayerName
.... name:nameInformation S 0..2 NlcoreNameInformation NameInformation
..... family S 0..1 string Family name (often called 'Surname')
... gender S 1..1 code Gender
... birthDate S 1..1 date DateOfBirth
... deceased[x] S 0..1 dateTime Indicates if the individual is deceased or not
... address
.... use S 0..1 code AddressType
.... postalCode S 0..1 string Postcode

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* NlcorePatient Patient
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... nationality N 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:code N 0..1 Extension Nationality Code
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "code"
....... value[x] N 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
...... extension:period N 0..1 Extension Nationality Period
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "period"
....... value[x] N 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 1..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:$this
.... identifier:bsn ΣN 0..* Identifier An identifier for this patient

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:patientnummer SΣ 1..1 Identifier Patientnummer zoals gebruikt in het EPD

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 0..1 uri The namespace for the identifier value
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Patientnummer
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation SΣC 0..2 NlcoreNameInformation NameInformation
zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... nameUsage N 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] N 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.

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


Required Pattern: official
..... text ΣC 0..1 string Text representation of the full name
..... family SΣC 0..1 string Family name (often called 'Surname')
nl-core-NameInformation-02: If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... prefix N 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] N 1..1 string Prefix
....... lastName N 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] N 1..1 string LastName
....... partnerPrefix N 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] N 1..1 string PartnerPrefix
....... partnerLastName N 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] N 1..1 string PartnerLastName
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given ΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... givenOrInitial N 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period ΣC 0..1 Period Time period when name was/is in use
per-1: If present, start SHALL have a lower value than end
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
... Slices for telecom ΣCN 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
cpt-2: A system is required if a value is provided.
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
cpt-2: A system is required if a value is provided.
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
cpt-2: A system is required if a value is provided.
... gender SΣ 1..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.

.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... genderCodelist N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] N 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (required): GeslachtCodelijst

.... value 0..1 code Primitive value for code
Max Length:1048576
... birthDate SΣ 1..1 date DateOfBirth
... Slices for deceased[x] ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime DateOfDeath
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
.... use ?!SΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.


Example General: home
.... type Σ 0..1 code AddressType
Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... streetName N 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] N 1..1 string Street
...... houseNumber N 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] N 1..1 string HouseNumber
...... houseNumberLetter-houseNumberAddition N 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] N 1..1 string HouseNumberLetter / HouseNumberAddition
...... houseNumberIndication N 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] CN 1..1 string HouseNumberIndication
houseNumberIndication: Must have value 'by' or 'to'
...... additionalInformation N 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] N 1..1 string AdditionalInformation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string PlaceOfResidence
Example General: Erewhon
.... district Σ 0..1 string Municipality
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postcode
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... countryCode N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
....... id 0..1 string Unique id for inter-element referencing
....... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
....... value[x] N 0..1 CodeableConcept Country
Binding: LandCodelijsten (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... period ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept MaritalStatus
Binding: BurgerlijkeStaatCodelijst (required): BurgerlijkeStaatCodelijst

... Slices for multipleBirth[x] N 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean N 0..1 boolean MultipleBirthIndicator
... photo C 0..* Attachment Image of the patient
att-1: If the Attachment has data, it SHALL have a contentType
... contact C 0..* BackboneElement Contact
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contactPerson N 0..1 (Complex) This contact may have further details in this RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] N 1..1 Reference(RelatedPerson | nl core ContactPerson) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for relationship N 0..* CodeableConcept The kind of relationship
Slice: Unordered, Open by value:$this
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... relationship:role N 0..* CodeableConcept Role
Binding: RolCodelijst (required): RolCodelijst


..... relationship:relationship N 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (required): RelatieCodelijst


.... name C 0..1 NlcoreNameInformation NameInformation
zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well
zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well
nl-core-NameInformation-01: If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
.... Slices for telecom CN 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
cpt-2: A system is required if a value is provided.
..... telecom:telephoneNumbers CN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
cpt-2: A system is required if a value is provided.
..... telecom:emailAddresses CN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
cpt-2: A system is required if a value is provided.
.... address 0..1 NlcoreAddressInformation AddressInformation
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
ref-1: SHALL have a contained resource if a local reference is provided
.... period C 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
per-1: If present, start SHALL have a lower value than end
... communication 0..* BackboneElement LanguageProficiency
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... languageControl N 0..* (Complex) LanguageControlListening / LanguageControlSpeaking / LanguageControlReading
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension N 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:level N 1..1 Extension The proficiency level of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "level"
........ value[x] N 1..1 Coding Value of extension
Binding: LanguageAbilityProficiency (required): The proficiency level for the communication.

....... extension:type N 1..1 Extension The proficiency type of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension N 0..0
........ url 1..1 uri "type"
........ value[x] N 1..1 Coding Value of extension
Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.

...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-proficiency"
..... communicationDetails N 0..* CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails
Binding: CommunicatieBijzonderhedenCodelijst (extensible)
..... comment N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
...... id 0..1 string Unique id for inter-element referencing
...... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
...... value[x] N 0..1 string Comment
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept CommunicationLanguage
Binding: CommunicatieTaalCodelijst (required): CommunicatieTaalCodelijst

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner C 0..* PatternNlCoreHealthProfessionalReference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole) A reference from one resource to another
ref-1: SHALL have a contained resource if a local reference is provided
... managingOrganization ΣC 0..1 Reference(Organization) Organization that is the custodian of the patient record
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other ΣC 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:nationality.extension:code.value[x]extensibleNationaliteitCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.identifier:patientnummer.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:patientnummer.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name:nameInformation.extension:nameUsage.value[x]requiredHumanNameAssemblyOrder
http://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1
from the FHIR Standard
Patient.name:nameInformation.userequiredPattern: official
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.gender.extension:genderCodelist.value[x]requiredGeslachtCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.country.extension:countryCode.value[x]requiredLandCodelijsten
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000
Patient.maritalStatusrequiredBurgerlijkeStaatCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.relationship:rolerequiredRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
Patient.contact.relationship:relationshiprequiredRelatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.extension:languageControl.extension:level.value[x]requiredLanguageAbilityProficiency
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:languageControl.extension:type.value[x]preferredLanguageAbilityMode
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.languagerequiredCommunicatieTaalCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorPatient.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorPatient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
houseNumberIndicationerrorPatient.address.line.extension:houseNumberIndication.value[x]Must have value 'by' or 'to'
: $this in ('by' | 'to')
nl-core-NameInformation-01warningPatient.name:nameInformation, Patient.contact.nameIf parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage.
: (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02warningPatient.name:nameInformation.familyIf parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage.
: (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
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()
per-1errorPatient.name:nameInformation.period, Patient.address.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorPatient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1errorPatient.name:nameInformation, Patient.contact.nameIf a prefix for a family name is specified, the family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2errorPatient.name:nameInformation, Patient.contact.nameIf the prefix for a partner family name is specified, the partner family name is expected as well
: family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcorePatient

Summary

Mandatory: 6 elements
Must-Support: 10 elements

 

Other representations of profile: CSV, Excel, Schematron