Advance Care Planning (PZP)
1.0.0-rc1 - trial-use

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

Resource Profile: Patient

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

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

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* NlcorePatient Patient
Constraints: ACP-Patient-1
... 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
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Nationality Code
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (2020-09-01T00:00:00) (extensible)
...... extension:period 0..1 Extension Nationality Period
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legallyCapableMedicalTreatmentDecisions OC 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapable"
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapableComment"
....... value[x] 0..1 string LegallyCapableComment
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... 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)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 1..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation Σ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
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ?!OΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... given OΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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)
Constraints: ext-1
..... suffix OΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... given OΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... Slices for extension Content/Rules for all slices
...... extension:comment O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system OΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (2020-09-01T00:00:00) (required)
..... value OΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!OΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... system OΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value OΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
... gender OΣ 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.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... Slices for extension Content/Rules for all slices
..... extension:genderCodelist O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (2020-09-01T00:00:00) (required): GeslachtCodelijst
... birthDate OΣ 0..1 date DateOfBirth
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime DateOfDeath
... 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)
Constraints: ext-1
.... use ?!OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... city OΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district OΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode OΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean 0..1 boolean MultipleBirthIndicator
... contact C 0..* BackboneElement Contact
Constraints: pat-1
.... Slices for extension Content/Rules for all slices
..... extension:contactPerson OC 0..1 (Complex) This contact may have further details in this RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] 1..1 Reference(ContactPerson(1.0.0-rc1)) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... Slices for relationship C 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 (2020-09-01T00:00:00) (required): RolCodelijst
..... relationship:relationship 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (required): RelatieCodelijst
.... 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
... 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
Constraints: ext-1
.... 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.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.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​system.extension:telecomType.​value[x] Base required TelecomTypeCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
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.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.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ACP-Patient-1 warning Patient If the patient is not legally capable, there should be a legal representative. extension.where(url='https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions').extension.where(url='legallyCapable').value = false implies (contact.where(relationship.coding.code = '24').exists() or contact.extension.where(url='http://hl7.org/fhir/StructureDefinition/patient-relatedPerson').exists())
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 Patient.implicitRules, Patient.extension:nationality, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:code.value[x], Patient.extension:nationality.extension:period, Patient.extension:nationality.extension:period.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:bsn, Patient.active, Patient.name, Patient.name:nameInformation, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.extension:nameUsage.value[x], Patient.name:nameInformation.use, Patient.name:nameInformation.given, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.name:nameInformation.suffix, Patient.name:nameInformation-GivenName, Patient.name:nameInformation-GivenName.use, Patient.name:nameInformation-GivenName.given, Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.extension:comment.value[x], Patient.telecom:telephoneNumbers.system, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.telecom:telephoneNumbers.system.extension:telecomType.value[x], Patient.telecom:telephoneNumbers.value, Patient.telecom:telephoneNumbers.use, Patient.telecom:emailAddresses, Patient.telecom:emailAddresses.system, Patient.telecom:emailAddresses.value, Patient.telecom:emailAddresses.use, Patient.gender, Patient.gender.extension:genderCodelist, Patient.gender.extension:genderCodelist.value[x], Patient.birthDate, Patient.deceased[x], Patient.deceased[x]:deceasedBoolean, Patient.deceased[x]:deceasedDateTime, Patient.address, Patient.address.extension:addressType, Patient.address.use, Patient.address.type, Patient.address.city, Patient.address.district, Patient.address.postalCode, Patient.multipleBirth[x], Patient.multipleBirth[x]:multipleBirthBoolean, Patient.contact, Patient.contact.extension:contactPerson, Patient.contact.extension:contactPerson.value[x], Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.relationship:role, Patient.contact.relationship:relationship, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses, Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension:nationality, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:period, Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.modifierExtension, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.gender.extension:genderCodelist, Patient.address.extension:addressType, Patient.contact.extension:contactPerson, Patient.contact.modifierExtension, Patient.link.modifierExtension 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()
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 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 C 0..* NlcorePatient Patient
... Slices for extension Content/Rules for all slices
.... extension:legallyCapableMedicalTreatmentDecisions OC 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
....... value[x] 0..1 string LegallyCapableComment
... identifier O 0..* Identifier PatientIdentificationNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... name 1..* HumanName NameInformation / PayerName
.... name:nameInformation 0..2 NlcoreNameInformation NameInformation
..... use O 1..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... family
...... Slices for extension Content/Rules for all slices
....... extension:prefix O 0..1 OwnPrefix(5.2.0) Voorvoegsel derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string Prefix
....... extension:lastName O 0..1 OwnName(5.2.0) Portion derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string LastName
....... extension:partnerPrefix O 0..1 PartnerPrefix(5.2.0) Voorvoegsel derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName O 0..1 PartnerName(5.2.0) Portion derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string PartnerLastName
..... given O 0..* string FirstName / Initial
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... suffix O 0..* string Titles
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... given O 1..* string GivenName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... telecom 0..* ContactPoint ContactInformation
... Slices for telecom Content/Rules for all slices
.... telecom:telephoneNumbers 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
..... Slices for extension Content/Rules for all slices
...... extension:comment O 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 0..1 string Comment
..... system O 1..1 code TelecomType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType O 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 0..1 CodeableConcept TelecomType
..... value O 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use O 0..1 code NumberType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses 0..* NlcoreContactInformationEmailAddresses EmailAddresses
..... system O 1..1 code email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value O 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... gender O 0..1 code Gender
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... Slices for extension Content/Rules for all slices
..... extension:genderCodelist O 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... value[x] 0..1 CodeableConcept Gender
... birthDate O 0..1 date DateOfBirth
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... address 0..* NlcoreAddressInformation AddressInformation
.... use O 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type O 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... line
..... Slices for extension Content/Rules for all slices
...... extension:streetName O 0..1 ADXPStreetName(5.2.0) streetName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string Street
...... extension:houseNumber O 0..1 ADXPHouseNumber(5.2.0) houseNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition O 0..1 ADXPBuildingNumberSuffix(5.2.0) buildingNumberSuffix
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication O 0..1 ADXPAdditionalLocator(5.2.0) additionalLocator
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string HouseNumberIndication
...... extension:additionalInformation O 0..1 ADXPUnitID(5.2.0) unitID
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string AdditionalInformation
.... city O 0..1 string PlaceOfResidence
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district O 0..1 string Municipality
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode O 0..1 string Postcode
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country
..... Slices for extension Content/Rules for all slices
...... extension:countryCode O 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 0..1 CodeableConcept Country
... contact C 0..* BackboneElement Contact
.... Slices for extension Content/Rules for all slices
..... extension:contactPerson OC 0..1 PatRelatedPerson(5.2.0) This contact may have further details in this RelatedPerson
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... value[x] 1..1 Reference(ContactPerson(1.0.0-rc1)) Contact
.... relationship C 0..* CodeableConcept The kind of relationship

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ACP-Patient-1 warning Patient If the patient is not legally capable, there should be a legal representative. extension.where(url='https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions').extension.where(url='legallyCapable').value = false implies (contact.where(relationship.coding.code = '24').exists() or contact.extension.where(url='http://hl7.org/fhir/StructureDefinition/patient-relatedPerson').exists())
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* NlcorePatient Patient
Constraints: ACP-Patient-1
... 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
Constraints: ext-1
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Constraints: ext-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
Constraints: ext-1
...... extension:code 0..1 Extension Nationality Code
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (2020-09-01T00:00:00) (extensible)
...... extension:period 0..1 Extension Nationality Period
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legallyCapableMedicalTreatmentDecisions OC 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... 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
Constraints: ext-1
...... extension:legallyCapable 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapable"
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapableComment"
....... value[x] 0..1 string LegallyCapableComment
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... Slices for identifier OΣ 0..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:$this
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... 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)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 1..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation Σ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
Constraints: ext-1
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ?!OΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... text ΣC 0..1 string Text representation of the full name
..... family Σ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
Constraints: ext-1
....... extension:prefix O 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName O 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix O 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName O 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ 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 OΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... 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
Constraints: ext-1
....... 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)
Constraints: ext-1
...... 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 OΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given OΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... 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
Constraints: ext-1
...... extension:comment O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system OΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... 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
Constraints: ext-1
....... extension:telecomType O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (2020-09-01T00:00:00) (required)
...... value 0..1 string Primitive value for code
..... value OΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!OΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... system OΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value OΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender OΣ 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.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... 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
Constraints: ext-1
..... extension:genderCodelist O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (2020-09-01T00:00:00) (required): GeslachtCodelijst
.... value 0..1 string Primitive value for code
... birthDate OΣ 0..1 date DateOfBirth
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... 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 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
Constraints: ext-1
.... use ?!OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... 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
Constraints: ext-1
...... extension:streetName O 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber O 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition O 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication O 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation O 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 OΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district OΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode OΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country Σ 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
Constraints: ext-1
...... extension:countryCode O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
....... value[x] 0..1 CodeableConcept Country
Binding: LandCodelijsten (2020-09-01T00:00:00) (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 (2020-09-01T00:00:00) (required): BurgerlijkeStaatCodelijst
... Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open 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
Constraints: ext-1
..... extension:contactPerson OC 0..1 (Complex) This contact may have further details in this RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] 1..1 Reference(ContactPerson(1.0.0-rc1)) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... Slices for relationship C 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 (2020-09-01T00:00:00) (required): RolCodelijst
..... relationship:relationship 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (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
Constraints: ext-1
..... extension:languageControl 0..* (Complex) LanguageControlListening / LanguageControlSpeaking / LanguageControlReading
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
Constraints: ext-1
...... 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
Constraints: ext-1
....... extension:level 1..1 Extension The proficiency level of the communication
Constraints: ext-1
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "level"
........ value[x] 1..1 Coding Value of extension
Binding: LanguageAbilityProficiency (3.0.0) (required): The proficiency level for the communication.
....... extension:type 1..1 Extension The proficiency type of the communication
Constraints: ext-1
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "type"
........ value[x] 1..1 Coding Value of extension
Binding: LanguageAbilityMode (3.0.0) (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)
Constraints: ext-1
..... extension:comment N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... 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
Constraints: ext-1
.... language 1..1 CodeableConcept CommunicationLanguage
Binding: CommunicatieTaalCodelijst (2020-09-01T00:00:00) (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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.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.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​system.extension:telecomType.​value[x] Base required TelecomTypeCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
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
ACP-Patient-1 warning Patient If the patient is not legally capable, there should be a legal representative. extension.where(url='https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions').extension.where(url='legallyCapable').value = false implies (contact.where(relationship.coding.code = '24').exists() or contact.extension.where(url='http://hl7.org/fhir/StructureDefinition/patient-relatedPerson').exists())
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 Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:nationality, Patient.extension:nationality.extension, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:code.value[x], Patient.extension:nationality.extension:period, Patient.extension:nationality.extension:period.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:bsn, Patient.active, Patient.name, Patient.name:nameInformation, Patient.name:nameInformation.extension, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.extension:nameUsage.value[x], Patient.name:nameInformation.use, Patient.name:nameInformation.text, Patient.name:nameInformation.family, Patient.name:nameInformation.family.extension, Patient.name:nameInformation.family.extension:prefix, Patient.name:nameInformation.family.extension:prefix.value[x], Patient.name:nameInformation.family.extension:lastName, Patient.name:nameInformation.family.extension:lastName.value[x], Patient.name:nameInformation.family.extension:partnerPrefix, Patient.name:nameInformation.family.extension:partnerPrefix.value[x], Patient.name:nameInformation.family.extension:partnerLastName, Patient.name:nameInformation.family.extension:partnerLastName.value[x], Patient.name:nameInformation.given, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.name:nameInformation.prefix, Patient.name:nameInformation.suffix, Patient.name:nameInformation.period, Patient.name:nameInformation-GivenName, Patient.name:nameInformation-GivenName.extension, Patient.name:nameInformation-GivenName.use, Patient.name:nameInformation-GivenName.text, Patient.name:nameInformation-GivenName.given, Patient.name:nameInformation-GivenName.period, Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:telephoneNumbers.extension, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.extension:comment.extension, Patient.telecom:telephoneNumbers.extension:comment.value[x], Patient.telecom:telephoneNumbers.system, Patient.telecom:telephoneNumbers.system.extension, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.telecom:telephoneNumbers.system.extension:telecomType.extension, Patient.telecom:telephoneNumbers.system.extension:telecomType.value[x], Patient.telecom:telephoneNumbers.value, Patient.telecom:telephoneNumbers.use, Patient.telecom:telephoneNumbers.rank, Patient.telecom:telephoneNumbers.period, Patient.telecom:emailAddresses, Patient.telecom:emailAddresses.extension, Patient.telecom:emailAddresses.system, Patient.telecom:emailAddresses.value, Patient.telecom:emailAddresses.use, Patient.telecom:emailAddresses.rank, Patient.telecom:emailAddresses.period, Patient.gender, Patient.gender.extension, Patient.gender.extension:genderCodelist, Patient.gender.extension:genderCodelist.extension, Patient.gender.extension:genderCodelist.value[x], Patient.birthDate, Patient.deceased[x], Patient.deceased[x]:deceasedBoolean, Patient.deceased[x]:deceasedDateTime, Patient.address, Patient.address.extension, Patient.address.extension:addressType, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:streetName.value[x], Patient.address.line.extension:houseNumber, Patient.address.line.extension:houseNumber.value[x], Patient.address.line.extension:houseNumberLetter-houseNumberAddition, Patient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x], Patient.address.line.extension:houseNumberIndication, Patient.address.line.extension:houseNumberIndication.value[x], Patient.address.line.extension:additionalInformation, Patient.address.line.extension:additionalInformation.value[x], Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.extension, Patient.address.country.extension:countryCode.value[x], Patient.address.period, Patient.maritalStatus, Patient.multipleBirth[x], Patient.multipleBirth[x]:multipleBirthBoolean, Patient.photo, Patient.contact, Patient.contact.extension, Patient.contact.extension:contactPerson, Patient.contact.extension:contactPerson.value[x], Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.relationship:role, Patient.contact.relationship:relationship, Patient.contact.name, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses, Patient.contact.address, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.extension:languageControl, Patient.communication.extension:languageControl.extension, Patient.communication.extension:languageControl.extension:level, Patient.communication.extension:languageControl.extension:level.value[x], Patient.communication.extension:languageControl.extension:type, Patient.communication.extension:languageControl.extension:type.value[x], Patient.communication.extension:communicationDetails, Patient.communication.extension:comment, Patient.communication.extension:comment.extension, Patient.communication.extension:comment.value[x], Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension, Patient.extension:nationality, Patient.extension:nationality.extension, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:period, Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.modifierExtension, Patient.name:nameInformation.extension, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.family.extension, Patient.name:nameInformation.family.extension:prefix, Patient.name:nameInformation.family.extension:lastName, Patient.name:nameInformation.family.extension:partnerPrefix, Patient.name:nameInformation.family.extension:partnerLastName, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.name:nameInformation-GivenName.extension, Patient.telecom:telephoneNumbers.extension, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.extension:comment.extension, Patient.telecom:telephoneNumbers.system.extension, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.telecom:telephoneNumbers.system.extension:telecomType.extension, Patient.telecom:emailAddresses.extension, Patient.gender.extension, Patient.gender.extension:genderCodelist, Patient.gender.extension:genderCodelist.extension, Patient.address.extension, Patient.address.extension:addressType, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:houseNumberLetter-houseNumberAddition, Patient.address.line.extension:houseNumberIndication, Patient.address.line.extension:additionalInformation, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.extension, Patient.contact.extension, Patient.contact.extension:contactPerson, Patient.contact.modifierExtension, Patient.communication.extension, Patient.communication.extension:languageControl, Patient.communication.extension:languageControl.extension, Patient.communication.extension:languageControl.extension:level, Patient.communication.extension:languageControl.extension:type, Patient.communication.extension:communicationDetails, Patient.communication.extension:comment, Patient.communication.extension:comment.extension, Patient.communication.modifierExtension, Patient.link.extension, Patient.link.modifierExtension 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: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* NlcorePatient Patient
Constraints: ACP-Patient-1
... 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
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:code 0..1 Extension Nationality Code
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (2020-09-01T00:00:00) (extensible)
...... extension:period 0..1 Extension Nationality Period
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legallyCapableMedicalTreatmentDecisions OC 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapable"
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapableComment"
....... value[x] 0..1 string LegallyCapableComment
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... 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)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 1..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation Σ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
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ?!OΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... given OΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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)
Constraints: ext-1
..... suffix OΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... given OΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... Slices for extension Content/Rules for all slices
...... extension:comment O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system OΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (2020-09-01T00:00:00) (required)
..... value OΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!OΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... system OΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value OΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
... gender OΣ 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.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... Slices for extension Content/Rules for all slices
..... extension:genderCodelist O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (2020-09-01T00:00:00) (required): GeslachtCodelijst
... birthDate OΣ 0..1 date DateOfBirth
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedBoolean ?!Σ 0..1 boolean DeathIndicator
.... deceased[x]:deceasedDateTime ?!Σ 0..1 dateTime DateOfDeath
... 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)
Constraints: ext-1
.... use ?!OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... city OΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district OΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode OΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open by type:$this
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
.... multipleBirth[x]:multipleBirthBoolean 0..1 boolean MultipleBirthIndicator
... contact C 0..* BackboneElement Contact
Constraints: pat-1
.... Slices for extension Content/Rules for all slices
..... extension:contactPerson OC 0..1 (Complex) This contact may have further details in this RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] 1..1 Reference(ContactPerson(1.0.0-rc1)) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... Slices for relationship C 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 (2020-09-01T00:00:00) (required): RolCodelijst
..... relationship:relationship 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (required): RelatieCodelijst
.... 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
... 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
Constraints: ext-1
.... 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.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.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​system.extension:telecomType.​value[x] Base required TelecomTypeCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
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.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.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ACP-Patient-1 warning Patient If the patient is not legally capable, there should be a legal representative. extension.where(url='https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions').extension.where(url='legallyCapable').value = false implies (contact.where(relationship.coding.code = '24').exists() or contact.extension.where(url='http://hl7.org/fhir/StructureDefinition/patient-relatedPerson').exists())
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 Patient.implicitRules, Patient.extension:nationality, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:code.value[x], Patient.extension:nationality.extension:period, Patient.extension:nationality.extension:period.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:bsn, Patient.active, Patient.name, Patient.name:nameInformation, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.extension:nameUsage.value[x], Patient.name:nameInformation.use, Patient.name:nameInformation.given, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.name:nameInformation.suffix, Patient.name:nameInformation-GivenName, Patient.name:nameInformation-GivenName.use, Patient.name:nameInformation-GivenName.given, Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.extension:comment.value[x], Patient.telecom:telephoneNumbers.system, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.telecom:telephoneNumbers.system.extension:telecomType.value[x], Patient.telecom:telephoneNumbers.value, Patient.telecom:telephoneNumbers.use, Patient.telecom:emailAddresses, Patient.telecom:emailAddresses.system, Patient.telecom:emailAddresses.value, Patient.telecom:emailAddresses.use, Patient.gender, Patient.gender.extension:genderCodelist, Patient.gender.extension:genderCodelist.value[x], Patient.birthDate, Patient.deceased[x], Patient.deceased[x]:deceasedBoolean, Patient.deceased[x]:deceasedDateTime, Patient.address, Patient.address.extension:addressType, Patient.address.use, Patient.address.type, Patient.address.city, Patient.address.district, Patient.address.postalCode, Patient.multipleBirth[x], Patient.multipleBirth[x]:multipleBirthBoolean, Patient.contact, Patient.contact.extension:contactPerson, Patient.contact.extension:contactPerson.value[x], Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.relationship:role, Patient.contact.relationship:relationship, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses, Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension:nationality, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:period, Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.modifierExtension, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.gender.extension:genderCodelist, Patient.address.extension:addressType, Patient.contact.extension:contactPerson, Patient.contact.modifierExtension, Patient.link.modifierExtension 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()
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 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 C 0..* NlcorePatient Patient
... Slices for extension Content/Rules for all slices
.... extension:legallyCapableMedicalTreatmentDecisions OC 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... Slices for extension Content/Rules for all slices
...... extension:legallyCapable 0..1 Extension Extension
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
....... value[x] 0..1 string LegallyCapableComment
... identifier O 0..* Identifier PatientIdentificationNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... name 1..* HumanName NameInformation / PayerName
.... name:nameInformation 0..2 NlcoreNameInformation NameInformation
..... use O 1..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... family
...... Slices for extension Content/Rules for all slices
....... extension:prefix O 0..1 OwnPrefix(5.2.0) Voorvoegsel derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string Prefix
....... extension:lastName O 0..1 OwnName(5.2.0) Portion derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string LastName
....... extension:partnerPrefix O 0..1 PartnerPrefix(5.2.0) Voorvoegsel derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName O 0..1 PartnerName(5.2.0) Portion derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 1..1 string PartnerLastName
..... given O 0..* string FirstName / Initial
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... suffix O 0..* string Titles
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... given O 1..* string GivenName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... telecom 0..* ContactPoint ContactInformation
... Slices for telecom Content/Rules for all slices
.... telecom:telephoneNumbers 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
..... Slices for extension Content/Rules for all slices
...... extension:comment O 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 0..1 string Comment
..... system O 1..1 code TelecomType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType O 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ value[x] 0..1 CodeableConcept TelecomType
..... value O 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use O 0..1 code NumberType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses 0..* NlcoreContactInformationEmailAddresses EmailAddresses
..... system O 1..1 code email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value O 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... gender O 0..1 code Gender
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... Slices for extension Content/Rules for all slices
..... extension:genderCodelist O 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... value[x] 0..1 CodeableConcept Gender
... birthDate O 0..1 date DateOfBirth
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... address 0..* NlcoreAddressInformation AddressInformation
.... use O 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type O 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... line
..... Slices for extension Content/Rules for all slices
...... extension:streetName O 0..1 ADXPStreetName(5.2.0) streetName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string Street
...... extension:houseNumber O 0..1 ADXPHouseNumber(5.2.0) houseNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition O 0..1 ADXPBuildingNumberSuffix(5.2.0) buildingNumberSuffix
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication O 0..1 ADXPAdditionalLocator(5.2.0) additionalLocator
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string HouseNumberIndication
...... extension:additionalInformation O 0..1 ADXPUnitID(5.2.0) unitID
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 1..1 string AdditionalInformation
.... city O 0..1 string PlaceOfResidence
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district O 0..1 string Municipality
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode O 0..1 string Postcode
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country
..... Slices for extension Content/Rules for all slices
...... extension:countryCode O 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... value[x] 0..1 CodeableConcept Country
... contact C 0..* BackboneElement Contact
.... Slices for extension Content/Rules for all slices
..... extension:contactPerson OC 0..1 PatRelatedPerson(5.2.0) This contact may have further details in this RelatedPerson
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... value[x] 1..1 Reference(ContactPerson(1.0.0-rc1)) Contact
.... relationship C 0..* CodeableConcept The kind of relationship

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ACP-Patient-1 warning Patient If the patient is not legally capable, there should be a legal representative. extension.where(url='https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions').extension.where(url='legallyCapable').value = false implies (contact.where(relationship.coding.code = '24').exists() or contact.extension.where(url='http://hl7.org/fhir/StructureDefinition/patient-relatedPerson').exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* NlcorePatient Patient
Constraints: ACP-Patient-1
... 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
Constraints: ext-1
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Constraints: ext-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
Constraints: ext-1
...... extension:code 0..1 Extension Nationality Code
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Nationality
Binding: NationaliteitCodelijst (2020-09-01T00:00:00) (extensible)
...... extension:period 0..1 Extension Nationality Period
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-nationality"
.... extension:legallyCapableMedicalTreatmentDecisions OC 0..1 (Complex) ext LegallyCapable regarding medical treatment decisions
URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... 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
Constraints: ext-1
...... extension:legallyCapable 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapable"
....... value[x] 0..1 boolean LegallyCapable
...... extension:legallyCapableComment 0..1 Extension Extension
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "legallyCapableComment"
....... value[x] 0..1 string LegallyCapableComment
..... url 1..1 uri "https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... Slices for identifier OΣ 0..* Identifier PatientIdentificationNumber
Slice: Unordered, Open by value:$this
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... 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)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... Slices for name Σ 1..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation Σ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
Constraints: ext-1
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 ?!OΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... text ΣC 0..1 string Text representation of the full name
..... family Σ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
Constraints: ext-1
....... extension:prefix O 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName O 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix O 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName O 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ 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 OΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... 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
Constraints: ext-1
....... 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)
Constraints: ext-1
...... 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 OΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given OΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... 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
Constraints: ext-1
...... extension:comment O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system OΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... 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
Constraints: ext-1
....... extension:telecomType O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (2020-09-01T00:00:00) (required)
...... value 0..1 string Primitive value for code
..... value OΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!OΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... system OΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value OΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender OΣ 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.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... 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
Constraints: ext-1
..... extension:genderCodelist O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
...... value[x] 0..1 CodeableConcept Gender
Binding: GeslachtCodelijst (2020-09-01T00:00:00) (required): GeslachtCodelijst
.... value 0..1 string Primitive value for code
... birthDate OΣ 0..1 date DateOfBirth
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... 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 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
Constraints: ext-1
.... use ?!OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type OΣ 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
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... 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
Constraints: ext-1
...... extension:streetName O 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber O 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition O 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication O 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation O 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... 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 OΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district OΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode OΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country Σ 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
Constraints: ext-1
...... extension:countryCode O 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
....... value[x] 0..1 CodeableConcept Country
Binding: LandCodelijsten (2020-09-01T00:00:00) (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 (2020-09-01T00:00:00) (required): BurgerlijkeStaatCodelijst
... Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Open 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
Constraints: ext-1
..... extension:contactPerson OC 0..1 (Complex) This contact may have further details in this RelatedPerson
URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
...... value[x] 1..1 Reference(ContactPerson(1.0.0-rc1)) Contact
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... Slices for relationship C 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 (2020-09-01T00:00:00) (required): RolCodelijst
..... relationship:relationship 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (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
Constraints: ext-1
..... extension:languageControl 0..* (Complex) LanguageControlListening / LanguageControlSpeaking / LanguageControlReading
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
Constraints: ext-1
...... 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
Constraints: ext-1
....... extension:level 1..1 Extension The proficiency level of the communication
Constraints: ext-1
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "level"
........ value[x] 1..1 Coding Value of extension
Binding: LanguageAbilityProficiency (3.0.0) (required): The proficiency level for the communication.
....... extension:type 1..1 Extension The proficiency type of the communication
Constraints: ext-1
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "type"
........ value[x] 1..1 Coding Value of extension
Binding: LanguageAbilityMode (3.0.0) (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)
Constraints: ext-1
..... extension:comment N 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... 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
Constraints: ext-1
.... language 1..1 CodeableConcept CommunicationLanguage
Binding: CommunicatieTaalCodelijst (2020-09-01T00:00:00) (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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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.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.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​system.extension:telecomType.​value[x] Base required TelecomTypeCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
Patient.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
Patient.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
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
ACP-Patient-1 warning Patient If the patient is not legally capable, there should be a legal representative. extension.where(url='https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ext-LegallyCapable-MedicalTreatmentDecisions').extension.where(url='legallyCapable').value = false implies (contact.where(relationship.coding.code = '24').exists() or contact.extension.where(url='http://hl7.org/fhir/StructureDefinition/patient-relatedPerson').exists())
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 Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:nationality, Patient.extension:nationality.extension, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:code.value[x], Patient.extension:nationality.extension:period, Patient.extension:nationality.extension:period.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable.value[x], Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment.value[x], Patient.modifierExtension, Patient.identifier, Patient.identifier:bsn, Patient.active, Patient.name, Patient.name:nameInformation, Patient.name:nameInformation.extension, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.extension:nameUsage.value[x], Patient.name:nameInformation.use, Patient.name:nameInformation.text, Patient.name:nameInformation.family, Patient.name:nameInformation.family.extension, Patient.name:nameInformation.family.extension:prefix, Patient.name:nameInformation.family.extension:prefix.value[x], Patient.name:nameInformation.family.extension:lastName, Patient.name:nameInformation.family.extension:lastName.value[x], Patient.name:nameInformation.family.extension:partnerPrefix, Patient.name:nameInformation.family.extension:partnerPrefix.value[x], Patient.name:nameInformation.family.extension:partnerLastName, Patient.name:nameInformation.family.extension:partnerLastName.value[x], Patient.name:nameInformation.given, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.name:nameInformation.prefix, Patient.name:nameInformation.suffix, Patient.name:nameInformation.period, Patient.name:nameInformation-GivenName, Patient.name:nameInformation-GivenName.extension, Patient.name:nameInformation-GivenName.use, Patient.name:nameInformation-GivenName.text, Patient.name:nameInformation-GivenName.given, Patient.name:nameInformation-GivenName.period, Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:telephoneNumbers.extension, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.extension:comment.extension, Patient.telecom:telephoneNumbers.extension:comment.value[x], Patient.telecom:telephoneNumbers.system, Patient.telecom:telephoneNumbers.system.extension, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.telecom:telephoneNumbers.system.extension:telecomType.extension, Patient.telecom:telephoneNumbers.system.extension:telecomType.value[x], Patient.telecom:telephoneNumbers.value, Patient.telecom:telephoneNumbers.use, Patient.telecom:telephoneNumbers.rank, Patient.telecom:telephoneNumbers.period, Patient.telecom:emailAddresses, Patient.telecom:emailAddresses.extension, Patient.telecom:emailAddresses.system, Patient.telecom:emailAddresses.value, Patient.telecom:emailAddresses.use, Patient.telecom:emailAddresses.rank, Patient.telecom:emailAddresses.period, Patient.gender, Patient.gender.extension, Patient.gender.extension:genderCodelist, Patient.gender.extension:genderCodelist.extension, Patient.gender.extension:genderCodelist.value[x], Patient.birthDate, Patient.deceased[x], Patient.deceased[x]:deceasedBoolean, Patient.deceased[x]:deceasedDateTime, Patient.address, Patient.address.extension, Patient.address.extension:addressType, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:streetName.value[x], Patient.address.line.extension:houseNumber, Patient.address.line.extension:houseNumber.value[x], Patient.address.line.extension:houseNumberLetter-houseNumberAddition, Patient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x], Patient.address.line.extension:houseNumberIndication, Patient.address.line.extension:houseNumberIndication.value[x], Patient.address.line.extension:additionalInformation, Patient.address.line.extension:additionalInformation.value[x], Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.extension, Patient.address.country.extension:countryCode.value[x], Patient.address.period, Patient.maritalStatus, Patient.multipleBirth[x], Patient.multipleBirth[x]:multipleBirthBoolean, Patient.photo, Patient.contact, Patient.contact.extension, Patient.contact.extension:contactPerson, Patient.contact.extension:contactPerson.value[x], Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.relationship:role, Patient.contact.relationship:relationship, Patient.contact.name, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses, Patient.contact.address, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.extension:languageControl, Patient.communication.extension:languageControl.extension, Patient.communication.extension:languageControl.extension:level, Patient.communication.extension:languageControl.extension:level.value[x], Patient.communication.extension:languageControl.extension:type, Patient.communication.extension:languageControl.extension:type.value[x], Patient.communication.extension:communicationDetails, Patient.communication.extension:comment, Patient.communication.extension:comment.extension, Patient.communication.extension:comment.value[x], Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension, Patient.extension:nationality, Patient.extension:nationality.extension, Patient.extension:nationality.extension:code, Patient.extension:nationality.extension:period, Patient.extension:legallyCapableMedicalTreatmentDecisions, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapable, Patient.extension:legallyCapableMedicalTreatmentDecisions.extension:legallyCapableComment, Patient.modifierExtension, Patient.name:nameInformation.extension, Patient.name:nameInformation.extension:nameUsage, Patient.name:nameInformation.family.extension, Patient.name:nameInformation.family.extension:prefix, Patient.name:nameInformation.family.extension:lastName, Patient.name:nameInformation.family.extension:partnerPrefix, Patient.name:nameInformation.family.extension:partnerLastName, Patient.name:nameInformation.given.extension, Patient.name:nameInformation.given.extension:givenOrInitial, Patient.name:nameInformation-GivenName.extension, Patient.telecom:telephoneNumbers.extension, Patient.telecom:telephoneNumbers.extension:comment, Patient.telecom:telephoneNumbers.extension:comment.extension, Patient.telecom:telephoneNumbers.system.extension, Patient.telecom:telephoneNumbers.system.extension:telecomType, Patient.telecom:telephoneNumbers.system.extension:telecomType.extension, Patient.telecom:emailAddresses.extension, Patient.gender.extension, Patient.gender.extension:genderCodelist, Patient.gender.extension:genderCodelist.extension, Patient.address.extension, Patient.address.extension:addressType, Patient.address.line.extension, Patient.address.line.extension:streetName, Patient.address.line.extension:houseNumber, Patient.address.line.extension:houseNumberLetter-houseNumberAddition, Patient.address.line.extension:houseNumberIndication, Patient.address.line.extension:additionalInformation, Patient.address.country.extension, Patient.address.country.extension:countryCode, Patient.address.country.extension:countryCode.extension, Patient.contact.extension, Patient.contact.extension:contactPerson, Patient.contact.modifierExtension, Patient.communication.extension, Patient.communication.extension:languageControl, Patient.communication.extension:languageControl.extension, Patient.communication.extension:languageControl.extension:level, Patient.communication.extension:languageControl.extension:type, Patient.communication.extension:communicationDetails, Patient.communication.extension:comment, Patient.communication.extension:comment.extension, Patient.communication.modifierExtension, Patient.link.extension, Patient.link.modifierExtension 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: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron