PLUGIN
0.0.2-ci - ci-build NL

PLUGIN - Local Development build (v0.0.2-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.0.2-ci
Draft as of 2025-10-08 Computable Name: PluginPatient

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

Maturity Level: 1 Draft. Describes the Patient resource as used by the Dutch PLUGIN project. Inherits from nl-core-Patient. Open issues see Github.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* NlcorePatient Patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Nationality Code
....... extension 0..0
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
...... extension:period 0..1 Extension Nationality Period
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:bsn Σ 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 Patiëntnummer zoals door zorgverleners gebruikt en getoond 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)
..... 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.
..... value Σ 1..1 string Patiëntnummer
Example General: 123456
.... identifier:zorgttp SΣ 0..1 Identifier Identifier zoals uitgegeven door ZorgTTP
... 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
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 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
..... family SΣC 0..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... Slices for extension Content/Rules for all slices
....... extension:prefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
... gender SΣ 0..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
.... Slices for extension Content/Rules for all slices
..... extension:genderCodelist N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
... birthDate SΣ 0..1 date DateOfBirth
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime DateOfDeath
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... Slices for extension Content/Rules for all slices
..... extension: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
.... postalCode SΣ 0..1 string Postcode
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... Slices for extension Content/Rules for all slices
...... extension:countryCode N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
... Slices for multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean 0..1 boolean MultipleBirthIndicator
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.value[x] Base extensible NationaliteitCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.identifier:patientnummer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientnummer.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nl-core-NameInformation-01 warning Patient.name:nameInformation 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. (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-02 warning Patient.name:nameInformation.family 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. (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()
zib-NameInformation-1 error Patient.name:nameInformation If 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-2 error Patient.name:nameInformation If 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 & Constraints    Filter: Filtersdoco
.. Patient 0..* NlcorePatient Patient
... identifier S 1..* Identifier PatientIdentificationNumber
... Slices for identifier Content/Rules for all slices
.... identifier:patientnummer S 1..1 Identifier Patiëntnummer zoals door zorgverleners gebruikt en getoond 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 Patiëntnummer
.... identifier:zorgttp S 0..1 Identifier Identifier zoals uitgegeven door ZorgTTP
... 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 0..1 code Gender
... birthDate S 0..1 date DateOfBirth
... deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not
... Slices for deceased[x] Content/Rules for all slices
.... deceased[x]:deceasedDateTime S 0..1 dateTime DateOfDeath
... address
.... use S 0..1 code AddressType
.... postalCode S 0..1 string Postcode
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... multipleBirth[x] S 0..1 boolean, integer Whether patient is part of a multiple birth

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:code 0..1 Extension Nationality Code
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
...... extension:period 0..1 Extension Nationality Period
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:$this
.... identifier:bsn Σ 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 Patiëntnummer zoals door zorgverleners gebruikt en getoond 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 Patiëntnummer
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)
.... identifier:zorgttp SΣ 0..1 Identifier Identifier zoals uitgegeven door ZorgTTP
... 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
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:nameUsage 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 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 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')
Constraints: nl-core-NameInformation-02
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 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 xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:givenOrInitial 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 Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
... gender SΣ 0..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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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 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] 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (required): GeslachtCodelijst
.... value 0..1 string Primitive value for code
... birthDate SΣ 0..1 date DateOfBirth
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime DateOfDeath
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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 xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:streetName 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] 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 SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension: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 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] 0..1 CodeableConcept Country
Binding: LandCodelijsten (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept MaritalStatus
Binding: BurgerlijkeStaatCodelijst (required): BurgerlijkeStaatCodelijst
... Slices for multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean 0..1 boolean MultipleBirthIndicator
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement Contact
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:contactPerson 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 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] 1..1 Reference(RelatedPerson | nl core ContactPerson) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for relationship 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 0..* CodeableConcept Role
Binding: RolCodelijst (required): RolCodelijst
..... relationship:relationship 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (required): RelatieCodelijst
.... name C 0..1 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
.... Slices for telecom 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
..... telecom:telephoneNumbers CN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... telecom:emailAddresses CN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
.... 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
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement LanguageProficiency
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:languageControl 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 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:level 1..1 Extension The proficiency level of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "level"
........ value[x] 1..1 Coding Value of extension
Binding: LanguageAbilityProficiency (required): The proficiency level for the communication.
....... extension:type 1..1 Extension The proficiency type of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "type"
........ value[x] 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"
..... extension:communicationDetails N 0..* CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails
Binding: CommunicatieBijzonderhedenCodelijst (extensible)
..... extension: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 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] 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 0..* Reference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.extension:nationality.​extension:code.value[x] Base extensible NationaliteitCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.identifier:patientnummer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientnummer.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.gender.extension:genderCodelist.​value[x] Base required GeslachtCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.country.​extension:countryCode.​value[x] Base required LandCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.maritalStatus Base required BurgerlijkeStaatCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.relationship:role Base required RolCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.contact.relationship:relationship Base required RelatieCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​extension:languageControl.​extension:level.value[x] Base required LanguageAbilityProficiency 📦3.0.0 THO v6.5
Patient.communication.​extension:languageControl.​extension:type.value[x] Base preferred LanguageAbilityMode 📦3.0.0 THO v6.5
Patient.communication.​language Base required CommunicatieTaalCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
houseNumberIndication error Patient.address.line.extension:houseNumberIndication.value[x] Must have value 'by' or 'to' $this in ('by' | 'to')
nl-core-NameInformation-01 warning Patient.name:nameInformation, Patient.contact.name 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. (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-02 warning Patient.name:nameInformation.family 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. (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-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()
zib-NameInformation-1 error Patient.name:nameInformation, Patient.contact.name If 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-2 error Patient.name:nameInformation, Patient.contact.name If 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: 4 elements
Must-Support: 14 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* NlcorePatient Patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Nationality Code
....... extension 0..0
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
...... extension:period 0..1 Extension Nationality Period
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:bsn Σ 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 Patiëntnummer zoals door zorgverleners gebruikt en getoond 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)
..... 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.
..... value Σ 1..1 string Patiëntnummer
Example General: 123456
.... identifier:zorgttp SΣ 0..1 Identifier Identifier zoals uitgegeven door ZorgTTP
... 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
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 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
..... family SΣC 0..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... Slices for extension Content/Rules for all slices
....... extension:prefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
... gender SΣ 0..1 code Gender
Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
.... Slices for extension Content/Rules for all slices
..... extension:genderCodelist N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
... birthDate SΣ 0..1 date DateOfBirth
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime DateOfDeath
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... Slices for extension Content/Rules for all slices
..... extension: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
.... postalCode SΣ 0..1 string Postcode
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... Slices for extension Content/Rules for all slices
...... extension:countryCode N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
... Slices for multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean 0..1 boolean MultipleBirthIndicator
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:nationality.​extension:code.value[x] Base extensible NationaliteitCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.identifier:patientnummer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientnummer.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
nl-core-NameInformation-01 warning Patient.name:nameInformation 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. (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-02 warning Patient.name:nameInformation.family 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. (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()
zib-NameInformation-1 error Patient.name:nameInformation If 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-2 error Patient.name:nameInformation If 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 & Constraints    Filter: Filtersdoco
.. Patient 0..* NlcorePatient Patient
... identifier S 1..* Identifier PatientIdentificationNumber
... Slices for identifier Content/Rules for all slices
.... identifier:patientnummer S 1..1 Identifier Patiëntnummer zoals door zorgverleners gebruikt en getoond 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 Patiëntnummer
.... identifier:zorgttp S 0..1 Identifier Identifier zoals uitgegeven door ZorgTTP
... 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 0..1 code Gender
... birthDate S 0..1 date DateOfBirth
... deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not
... Slices for deceased[x] Content/Rules for all slices
.... deceased[x]:deceasedDateTime S 0..1 dateTime DateOfDeath
... address
.... use S 0..1 code AddressType
.... postalCode S 0..1 string Postcode
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... multipleBirth[x] S 0..1 boolean, integer Whether patient is part of a multiple birth

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:code 0..1 Extension Nationality Code
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (extensible)
...... extension:period 0..1 Extension Nationality Period
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:$this
.... identifier:bsn Σ 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 Patiëntnummer zoals door zorgverleners gebruikt en getoond 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 Patiëntnummer
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)
.... identifier:zorgttp SΣ 0..1 Identifier Identifier zoals uitgegeven door ZorgTTP
... 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
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:nameUsage 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 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 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')
Constraints: nl-core-NameInformation-02
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:prefix 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName 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 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 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 xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:givenOrInitial 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 Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
... gender SΣ 0..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 xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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 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] 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (required): GeslachtCodelijst
.... value 0..1 string Primitive value for code
... birthDate SΣ 0..1 date DateOfBirth
... Slices for deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime DateOfDeath
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension: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 xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:streetName 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] 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 SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension: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 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] 0..1 CodeableConcept Country
Binding: LandCodelijsten (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept MaritalStatus
Binding: BurgerlijkeStaatCodelijst (required): BurgerlijkeStaatCodelijst
... Slices for multipleBirth[x] S 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean 0..1 boolean MultipleBirthIndicator
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement Contact
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:contactPerson 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 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] 1..1 Reference(RelatedPerson | nl core ContactPerson) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for relationship 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 0..* CodeableConcept Role
Binding: RolCodelijst (required): RolCodelijst
..... relationship:relationship 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (required): RelatieCodelijst
.... name C 0..1 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
.... Slices for telecom 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
..... telecom:telephoneNumbers CN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... telecom:emailAddresses CN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
.... 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
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement LanguageProficiency
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:languageControl 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 2..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:level 1..1 Extension The proficiency level of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "level"
........ value[x] 1..1 Coding Value of extension
Binding: LanguageAbilityProficiency (required): The proficiency level for the communication.
....... extension:type 1..1 Extension The proficiency type of the communication
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "type"
........ value[x] 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"
..... extension:communicationDetails N 0..* CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails
Binding: CommunicatieBijzonderhedenCodelijst (extensible)
..... extension: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 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] 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 0..* Reference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.extension:nationality.​extension:code.value[x] Base extensible NationaliteitCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.identifier:patientnummer.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientnummer.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
Patient.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.gender.extension:genderCodelist.​value[x] Base required GeslachtCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.country.​extension:countryCode.​value[x] Base required LandCodelijsten 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.maritalStatus Base required BurgerlijkeStaatCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.relationship:role Base required RolCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.contact.relationship:relationship Base required RelatieCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​extension:languageControl.​extension:level.value[x] Base required LanguageAbilityProficiency 📦3.0.0 THO v6.5
Patient.communication.​extension:languageControl.​extension:type.value[x] Base preferred LanguageAbilityMode 📦3.0.0 THO v6.5
Patient.communication.​language Base required CommunicatieTaalCodelijst 📦2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
houseNumberIndication error Patient.address.line.extension:houseNumberIndication.value[x] Must have value 'by' or 'to' $this in ('by' | 'to')
nl-core-NameInformation-01 warning Patient.name:nameInformation, Patient.contact.name 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. (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-02 warning Patient.name:nameInformation.family 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. (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-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()
zib-NameInformation-1 error Patient.name:nameInformation, Patient.contact.name If 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-2 error Patient.name:nameInformation, Patient.contact.name If 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: 4 elements
Must-Support: 14 elements

 

Other representations of profile: CSV, Excel, Schematron