Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build
NL
Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build
NL
Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2Patient | Version: 0.15.0 | |||
| Draft as of 2023-01-24 |
Realm: 
|
Computable Name: KT2_Patient | ||
Copyright/Legal: VZVZ |
||||
The Patient resource represents a person receiving healthcare services within the Koppeltaal ecosystem. Patients can be assigned eHealth activities and are the primary focus of care coordination between different healthcare applications. This profile extends the NlcorePatient profile with Koppeltaal-specific requirements.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Patient |
0..* | NlcorePatient | Patient | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 1..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:$this |
 identifier:bsn |
Σ | 0..* | Identifier | An identifier for this patient Required Pattern: At least the following |
  id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
0..1 | CodeableConcept | Description of identifier | |
 system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | |
| value |
0..1 | string | The value that is unique | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
 assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| active |
?!Σ | 1..1 | boolean | Whether this patient's record is in active use |
| Slices for name |
ΣC | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use Constraints: kt2pnu-2 |
 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 | |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
| value[x] |
1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |
| use |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official |
| text |
ΣC | 0..1 | string | Text representation of the full name |
| family |
ΣC | 1..1 | string | Family name (often called 'Surname') Constraints: nl-core-NameInformation-02 |
 Slices for extension |
Content/Rules for all slices | |||
| extension:prefix |
0..1 | (Complex) | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |
| value[x] |
1..1 | string | Prefix | |
| extension:lastName |
0..1 | (Complex) | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |
| value[x] |
1..1 | string | LastName | |
| extension:partnerPrefix |
0..1 | (Complex) | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |
| value[x] |
1..1 | string | PartnerPrefix | |
| extension:partnerLastName |
0..1 | (Complex) | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |
| value[x] |
1..1 | string | PartnerLastName | |
| given |
ΣC | 1..* | string | FirstName / Initial This repeating element order: Given Names appear in the correct order for presenting the name |
| Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:givenOrInitial |
1..* | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required) | |
| prefix |
Σ | 0..* | string | Titles This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix |
Σ | 0..* | string | Titles This repeating element order: Suffixes appear in the correct order for presenting the name |
| period |
Σ | 0..1 | Period | Time period when name was/is in use |
| name:nameInformation-GivenName |
Σ | 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 |
| text |
Σ | 0..1 | string | Text representation of the full name |
| given |
Σ | 1..* | string | GivenName This repeating element order: Given Names appear in the correct order for presenting the name |
| 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 |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| system |
ΣC | 1..1 | code | TelecomType Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:telecomType |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| use |
?!Σ | 0..1 | code | NumberType Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. |
| 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 |
| system |
ΣC | 1..1 | code | email Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
| use |
?!Σ | 0..1 | code | EmailAddressType Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (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 |
Σ | 1..1 | code | Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:genderCodelist |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| birthDate |
Σ | 1..1 | date | DateOfBirth |
  managingOrganization |
Σ | 0..1 | Reference(KT2_Organization) | Organization that is the custodian of the patient record |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.extension:nationality.extension:code.value[x] | extensible | NationaliteitCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 | ||||
| Patient.name:nameInformation.extension:nameUsage.value[x] | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation-GivenName.use | required | Pattern Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.telecom:telephoneNumbers.system | required | ContactInformationTelephoneNumbersSystemhttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem | ||||
| Patient.telecom:telephoneNumbers.use | required | ContactInformationTelephoneNumbersUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse | ||||
| Patient.telecom:emailAddresses.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Patient.telecom:emailAddresses.use | required | ContactInformationEmailAddressesUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipFrom the FHIR Standard | ||||
| Patient.contact.relationship:role | required | RolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 | ||||
| Patient.contact.relationship:relationship | required | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| Patient.communication.extension:languageControl.extension:level.value[x] | required | LanguageAbilityProficiencyhttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency | ||||
| Patient.communication.extension:languageControl.extension:type.value[x] | preferred | LanguageAbilityModehttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode | ||||
| Patient.communication.language | required | CommunicatieTaalCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
| ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| kt2pnu-2 | error | Patient.name | Patient name use must not be empty : use.hasValue() | |
| nl-core-NameInformation-01 | warning | Patient.name:nameInformation | If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. : (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue() | |
| nl-core-NameInformation-02 | warning | Patient.name:nameInformation.family | If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage. : (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue() | |
| zib-NameInformation-1 | error | Patient.name:nameInformation | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | Patient.name:nameInformation | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
This structure is derived from NlcorePatient
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
NlcorePatient | |||
| Slices for extension |
Content/Rules for all slices | |||
 extension:nationality |
0..0 | |||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
 identifier |
1..* | Identifier | PatientIdentificationNumber | |
| active |
1..1 | boolean | Whether this patient's record is in active use | |
| name |
C | 1..* | HumanName | NameInformation / PayerName Constraints: kt2pnu-2 |
| Slices for name |
Content/Rules for all slices | |||
| name:nameInformation |
0..2 | NlcoreNameInformation | NameInformation | |
| text |
0..1 | string | Text representation of the full name | |
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..* | string | FirstName / Initial | |
| prefix |
0..* | string | Titles | |
| suffix |
0..* | string | Titles | |
| period |
0..1 | Period | Time period when name was/is in use | |
| name:nameInformation-GivenName |
0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | |
| text |
0..1 | string | Text representation of the full name | |
| Slices for telecom |
Content/Rules for all slices | |||
| telecom:telephoneNumbers |
0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | |
| 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 |
0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | |
| 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 |
1..1 | code | Gender | |
| birthDate |
1..1 | date | DateOfBirth | |
| deceased[x] |
0..0 | |||
| Slices for deceased[x] |
Content/Rules for all slices | |||
| deceased[x]:deceasedBoolean |
0..0 | |||
| deceased[x]:deceasedDateTime |
0..0 | |||
| address |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:addressType |
0..1 | ExtAddressInformationAddressType | Optional Extensions Element | |
| type |
0..1 | code | AddressType | |
| text |
0..1 | string | Text representation of the address | |
| district |
0..1 | string | Municipality | |
| state |
0..1 | string | Sub-unit of country (abbreviations ok) | |
| country |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:countryCode |
0..1 | ExtCodeSpecification | Optional Extensions Element | |
| extension |
0..0 | |||
| value[x] |
0..1 | CodeableConcept | Country | |
| period |
0..1 | Period | Time period when address was/is in use | |
| maritalStatus |
0..0 | |||
| multipleBirth[x] |
0..0 | |||
| Slices for multipleBirth[x] |
Content/Rules for all slices | |||
| multipleBirth[x]:multipleBirthBoolean |
0..0 | |||
| photo |
0..0 | |||
| contact |
0..0 | |||
| communication |
0..0 | |||
| generalPractitioner |
0..0 | |||
| managingOrganization |
0..1 | Reference(KT2_Organization) | Organization that is the custodian of the patient record | |
| link |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| kt2pnu-2 | error | Patient.name | Patient name use must not be empty : use.hasValue() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | NlcorePatient | Patient | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 1..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:$this | ||||
| identifier:bsn |
Σ | 0..* | Identifier | An identifier for this patient Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type |
0..1 | CodeableConcept | Description of identifier | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | |||||
| value |
0..1 | string | The value that is unique | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
?!Σ | 1..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name |
ΣC | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use Constraints: kt2pnu-2 | ||||
| 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 | |||||
| extension:nameUsage |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
| value[x] |
1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |||||
| use |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text |
ΣC | 0..1 | string | Text representation of the full name | ||||
| family |
ΣC | 1..1 | string | Family name (often called 'Surname') Constraints: nl-core-NameInformation-02 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:prefix |
0..1 | (Complex) | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
| value[x] |
1..1 | string | Prefix | |||||
| extension:lastName |
0..1 | (Complex) | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
| value[x] |
1..1 | string | LastName | |||||
| extension:partnerPrefix |
0..1 | (Complex) | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
| value[x] |
1..1 | string | PartnerPrefix | |||||
| extension:partnerLastName |
0..1 | (Complex) | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
| value[x] |
1..1 | string | PartnerLastName | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| given |
ΣC | 1..* | string | FirstName / Initial This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:givenOrInitial |
1..* | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| prefix |
Σ | 0..* | string | Titles This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Titles This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:nameInformation-GivenName |
Σ | 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 | |||||
| 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 |
Σ | 1..* | string | GivenName This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| 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 | |||||
| extension:comment |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] |
0..1 | string | Comment | |||||
| system |
ΣC | 1..1 | code | TelecomType Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:telecomType |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] |
0..1 | CodeableConcept | TelecomType Binding: TelecomTypeCodelijst (required) | |||||
| value |
0..1 | string | Primitive value for code | |||||
| value |
Σ | 0..1 | string | TelephoneNumber | ||||
| use |
?!Σ | 0..1 | code | NumberType Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. | ||||
| 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 | |||||
| system |
ΣC | 1..1 | code | email Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
| value |
Σ | 0..1 | string | EmailAddress | ||||
| use |
?!Σ | 0..1 | code | EmailAddressType Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (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 |
Σ | 1..1 | code | Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:genderCodelist |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] |
0..1 | CodeableConcept | Gender Binding: GeslachtCodelijst (required): GeslachtCodelijst | |||||
| value |
0..1 | string | Primitive value for code | |||||
| birthDate |
Σ | 1..1 | date | DateOfBirth | ||||
| address |
Σ | 0..* | NlcoreAddressInformation | AddressInformation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:addressType |
0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType Binding: AdresSoortCodelijst (extensible) | |||||
| use |
?!Σ | 0..1 | code | AddressType Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse. Example General: home | ||||
| type |
Σ | 0..1 | code | AddressType Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType. Example General: both | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:streetName |
0..1 | (Complex) | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" | |||||
| value[x] |
1..1 | string | Street | |||||
| extension:houseNumber |
0..1 | (Complex) | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" | |||||
| value[x] |
1..1 | string | HouseNumber | |||||
| extension:houseNumberLetter-houseNumberAddition |
0..1 | (Complex) | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix" | |||||
| value[x] |
1..1 | string | HouseNumberLetter / HouseNumberAddition | |||||
| extension:houseNumberIndication |
0..1 | (Complex) | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator" | |||||
| value[x] |
C | 1..1 | string | HouseNumberIndication Constraints: houseNumberIndication | ||||
| extension:additionalInformation |
0..1 | (Complex) | unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID" | |||||
| value[x] |
1..1 | string | AdditionalInformation | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| city |
Σ | 0..1 | string | PlaceOfResidence Example General: Erewhon | ||||
| district |
Σ | 0..1 | string | Municipality Example General: Madison | ||||
| state |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode |
Σ | 0..1 | string | Postcode Example General: 9132 | ||||
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:countryCode |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] |
0..1 | CodeableConcept | Country Binding: LandCodelijsten (required) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| managingOrganization |
Σ | 0..1 | Reference(KT2_Organization) | Organization that is the custodian of the patient record | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Patient.extension:nationality.extension:code.value[x] | extensible | NationaliteitCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 | ||||
| Patient.name:nameInformation.extension:nameUsage.value[x] | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation-GivenName.use | required | Pattern Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.telecom:telephoneNumbers.system | required | ContactInformationTelephoneNumbersSystemhttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem | ||||
| Patient.telecom:telephoneNumbers.system.extension:telecomType.value[x] | required | TelecomTypeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000 | ||||
| Patient.telecom:telephoneNumbers.use | required | ContactInformationTelephoneNumbersUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse | ||||
| Patient.telecom:emailAddresses.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Patient.telecom:emailAddresses.use | required | ContactInformationEmailAddressesUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.gender.extension:genderCodelist.value[x] | required | GeslachtCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard | ||||
| Patient.address.country.extension:countryCode.value[x] | required | LandCodelijstenhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000 | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipFrom the FHIR Standard | ||||
| Patient.contact.relationship:role | required | RolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 | ||||
| Patient.contact.relationship:relationship | required | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.communication.extension:languageControl.extension:level.value[x] | required | LanguageAbilityProficiencyhttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency | ||||
| Patient.communication.extension:languageControl.extension:type.value[x] | preferred | LanguageAbilityModehttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode | ||||
| Patient.communication.language | required | CommunicatieTaalCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
| ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| houseNumberIndication | error | Patient.address.line.extension:houseNumberIndication.value[x] | Must have value 'by' or 'to' : $this in ('by' | 'to') | |
| kt2pnu-2 | error | Patient.name | Patient name use must not be empty : use.hasValue() | |
| 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() | |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
0..* | NlcorePatient | Patient | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 1..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:$this |
| identifier:bsn |
Σ | 0..* | Identifier | An identifier for this patient Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | |
| value |
0..1 | string | The value that is unique | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| active |
?!Σ | 1..1 | boolean | Whether this patient's record is in active use |
| Slices for name |
ΣC | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use Constraints: kt2pnu-2 |
| 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 | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |
| value[x] |
1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |
| use |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official |
| text |
ΣC | 0..1 | string | Text representation of the full name |
| family |
ΣC | 1..1 | string | Family name (often called 'Surname') Constraints: nl-core-NameInformation-02 |
| Slices for extension |
Content/Rules for all slices | |||
| extension:prefix |
0..1 | (Complex) | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |
| value[x] |
1..1 | string | Prefix | |
| extension:lastName |
0..1 | (Complex) | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |
| value[x] |
1..1 | string | LastName | |
| extension:partnerPrefix |
0..1 | (Complex) | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |
| value[x] |
1..1 | string | PartnerPrefix | |
| extension:partnerLastName |
0..1 | (Complex) | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |
| value[x] |
1..1 | string | PartnerLastName | |
| given |
ΣC | 1..* | string | FirstName / Initial This repeating element order: Given Names appear in the correct order for presenting the name |
| Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:givenOrInitial |
1..* | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required) | |
| prefix |
Σ | 0..* | string | Titles This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix |
Σ | 0..* | string | Titles This repeating element order: Suffixes appear in the correct order for presenting the name |
| period |
Σ | 0..1 | Period | Time period when name was/is in use |
| name:nameInformation-GivenName |
Σ | 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 |
| text |
Σ | 0..1 | string | Text representation of the full name |
| given |
Σ | 1..* | string | GivenName This repeating element order: Given Names appear in the correct order for presenting the name |
| 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 |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| system |
ΣC | 1..1 | code | TelecomType Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:telecomType |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| use |
?!Σ | 0..1 | code | NumberType Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. |
| 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 |
| system |
ΣC | 1..1 | code | email Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
| use |
?!Σ | 0..1 | code | EmailAddressType Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (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 |
Σ | 1..1 | code | Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. |
| Slices for extension |
Content/Rules for all slices | |||
| extension:genderCodelist |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| birthDate |
Σ | 1..1 | date | DateOfBirth |
| managingOrganization |
Σ | 0..1 | Reference(KT2_Organization) | Organization that is the custodian of the patient record |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.extension:nationality.extension:code.value[x] | extensible | NationaliteitCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 | ||||
| Patient.name:nameInformation.extension:nameUsage.value[x] | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation-GivenName.use | required | Pattern Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.telecom:telephoneNumbers.system | required | ContactInformationTelephoneNumbersSystemhttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem | ||||
| Patient.telecom:telephoneNumbers.use | required | ContactInformationTelephoneNumbersUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse | ||||
| Patient.telecom:emailAddresses.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Patient.telecom:emailAddresses.use | required | ContactInformationEmailAddressesUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipFrom the FHIR Standard | ||||
| Patient.contact.relationship:role | required | RolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 | ||||
| Patient.contact.relationship:relationship | required | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| Patient.communication.extension:languageControl.extension:level.value[x] | required | LanguageAbilityProficiencyhttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency | ||||
| Patient.communication.extension:languageControl.extension:type.value[x] | preferred | LanguageAbilityModehttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode | ||||
| Patient.communication.language | required | CommunicatieTaalCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
| ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| kt2pnu-2 | error | Patient.name | Patient name use must not be empty : use.hasValue() | |
| nl-core-NameInformation-01 | warning | Patient.name:nameInformation | If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. : (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue() | |
| nl-core-NameInformation-02 | warning | Patient.name:nameInformation.family | If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage. : (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue() | |
| zib-NameInformation-1 | error | Patient.name:nameInformation | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | Patient.name:nameInformation | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
Differential View
This structure is derived from NlcorePatient
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Patient |
NlcorePatient | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:nationality |
0..0 | |||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
| identifier |
1..* | Identifier | PatientIdentificationNumber | |
| active |
1..1 | boolean | Whether this patient's record is in active use | |
| name |
C | 1..* | HumanName | NameInformation / PayerName Constraints: kt2pnu-2 |
| Slices for name |
Content/Rules for all slices | |||
| name:nameInformation |
0..2 | NlcoreNameInformation | NameInformation | |
| text |
0..1 | string | Text representation of the full name | |
| family |
1..1 | string | Family name (often called 'Surname') | |
| given |
1..* | string | FirstName / Initial | |
| prefix |
0..* | string | Titles | |
| suffix |
0..* | string | Titles | |
| period |
0..1 | Period | Time period when name was/is in use | |
| name:nameInformation-GivenName |
0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | |
| text |
0..1 | string | Text representation of the full name | |
| Slices for telecom |
Content/Rules for all slices | |||
| telecom:telephoneNumbers |
0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | |
| 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 |
0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | |
| 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 |
1..1 | code | Gender | |
| birthDate |
1..1 | date | DateOfBirth | |
| deceased[x] |
0..0 | |||
| Slices for deceased[x] |
Content/Rules for all slices | |||
| deceased[x]:deceasedBoolean |
0..0 | |||
| deceased[x]:deceasedDateTime |
0..0 | |||
| address |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:addressType |
0..1 | ExtAddressInformationAddressType | Optional Extensions Element | |
| type |
0..1 | code | AddressType | |
| text |
0..1 | string | Text representation of the address | |
| district |
0..1 | string | Municipality | |
| state |
0..1 | string | Sub-unit of country (abbreviations ok) | |
| country |
||||
| Slices for extension |
Content/Rules for all slices | |||
| extension:countryCode |
0..1 | ExtCodeSpecification | Optional Extensions Element | |
| extension |
0..0 | |||
| value[x] |
0..1 | CodeableConcept | Country | |
| period |
0..1 | Period | Time period when address was/is in use | |
| maritalStatus |
0..0 | |||
| multipleBirth[x] |
0..0 | |||
| Slices for multipleBirth[x] |
Content/Rules for all slices | |||
| multipleBirth[x]:multipleBirthBoolean |
0..0 | |||
| photo |
0..0 | |||
| contact |
0..0 | |||
| communication |
0..0 | |||
| generalPractitioner |
0..0 | |||
| managingOrganization |
0..1 | Reference(KT2_Organization) | Organization that is the custodian of the patient record | |
| link |
0..0 | |||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| kt2pnu-2 | error | Patient.name | Patient name use must not be empty : use.hasValue() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | NlcorePatient | Patient | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 1..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:$this | ||||
| identifier:bsn |
Σ | 0..* | Identifier | An identifier for this patient Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type |
0..1 | CodeableConcept | Description of identifier | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | |||||
| value |
0..1 | string | The value that is unique | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active |
?!Σ | 1..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name |
ΣC | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use Constraints: kt2pnu-2 | ||||
| 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 | |||||
| extension:nameUsage |
0..1 | (Complex) | Preferred display order of name parts URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order" | |||||
| value[x] |
1..1 | code | NameUsage Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder. | |||||
| use |
?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text |
ΣC | 0..1 | string | Text representation of the full name | ||||
| family |
ΣC | 1..1 | string | Family name (often called 'Surname') Constraints: nl-core-NameInformation-02 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:prefix |
0..1 | (Complex) | Voorvoegsel derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" | |||||
| value[x] |
1..1 | string | Prefix | |||||
| extension:lastName |
0..1 | (Complex) | Portion derived from person's own surname URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-own-name" | |||||
| value[x] |
1..1 | string | LastName | |||||
| extension:partnerPrefix |
0..1 | (Complex) | Voorvoegsel derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix" | |||||
| value[x] |
1..1 | string | PartnerPrefix | |||||
| extension:partnerLastName |
0..1 | (Complex) | Portion derived from person's partner's surname URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" | |||||
| value[x] |
1..1 | string | PartnerLastName | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| given |
ΣC | 1..* | string | FirstName / Initial This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:givenOrInitial |
1..* | code | LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Binding: EntityNamePartQualifier (required) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| prefix |
Σ | 0..* | string | Titles This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Titles This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| name:nameInformation-GivenName |
Σ | 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 | |||||
| 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 |
Σ | 1..* | string | GivenName This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| 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 | |||||
| extension:comment |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] |
0..1 | string | Comment | |||||
| system |
ΣC | 1..1 | code | TelecomType Binding: ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:telecomType |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] |
0..1 | CodeableConcept | TelecomType Binding: TelecomTypeCodelijst (required) | |||||
| value |
0..1 | string | Primitive value for code | |||||
| value |
Σ | 0..1 | string | TelephoneNumber | ||||
| use |
?!Σ | 0..1 | code | NumberType Binding: ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. | ||||
| 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 | |||||
| system |
ΣC | 1..1 | code | email Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
| value |
Σ | 0..1 | string | EmailAddress | ||||
| use |
?!Σ | 0..1 | code | EmailAddressType Binding: ContactPointUse ValueSet for zib ContactInformation EmailAddress (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 |
Σ | 1..1 | code | Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:genderCodelist |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] |
0..1 | CodeableConcept | Gender Binding: GeslachtCodelijst (required): GeslachtCodelijst | |||||
| value |
0..1 | string | Primitive value for code | |||||
| birthDate |
Σ | 1..1 | date | DateOfBirth | ||||
| address |
Σ | 0..* | NlcoreAddressInformation | AddressInformation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:addressType |
0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType Binding: AdresSoortCodelijst (extensible) | |||||
| use |
?!Σ | 0..1 | code | AddressType Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse. Example General: home | ||||
| type |
Σ | 0..1 | code | AddressType Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType. Example General: both | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:streetName |
0..1 | (Complex) | streetName URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" | |||||
| value[x] |
1..1 | string | Street | |||||
| extension:houseNumber |
0..1 | (Complex) | houseNumber URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber" | |||||
| value[x] |
1..1 | string | HouseNumber | |||||
| extension:houseNumberLetter-houseNumberAddition |
0..1 | (Complex) | buildingNumberSuffix URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix" | |||||
| value[x] |
1..1 | string | HouseNumberLetter / HouseNumberAddition | |||||
| extension:houseNumberIndication |
0..1 | (Complex) | additionalLocator URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator" | |||||
| value[x] |
C | 1..1 | string | HouseNumberIndication Constraints: houseNumberIndication | ||||
| extension:additionalInformation |
0..1 | (Complex) | unitID URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID" | |||||
| value[x] |
1..1 | string | AdditionalInformation | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| city |
Σ | 0..1 | string | PlaceOfResidence Example General: Erewhon | ||||
| district |
Σ | 0..1 | string | Municipality Example General: Madison | ||||
| state |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode |
Σ | 0..1 | string | Postcode Example General: 9132 | ||||
| country |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:countryCode |
0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] |
0..1 | CodeableConcept | Country Binding: LandCodelijsten (required) | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| managingOrganization |
Σ | 0..1 | Reference(KT2_Organization) | Organization that is the custodian of the patient record | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Patient.extension:nationality.extension:code.value[x] | extensible | NationaliteitCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 | ||||
| Patient.name:nameInformation.extension:nameUsage.value[x] | required | HumanNameAssemblyOrderhttp://hl7.org/fhir/ValueSet/name-assembly-order|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.name:nameInformation-GivenName.use | required | Pattern Value: usualhttp://hl7.org/fhir/ValueSet/name-use|4.0.1From the FHIR Standard | ||||
| Patient.telecom:telephoneNumbers.system | required | ContactInformationTelephoneNumbersSystemhttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersSystem | ||||
| Patient.telecom:telephoneNumbers.system.extension:telecomType.value[x] | required | TelecomTypeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.20.6.1--20200901000000 | ||||
| Patient.telecom:telephoneNumbers.use | required | ContactInformationTelephoneNumbersUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-TelephoneNumbersUse | ||||
| Patient.telecom:emailAddresses.system | required | Pattern Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| Patient.telecom:emailAddresses.use | required | ContactInformationEmailAddressesUsehttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.gender.extension:genderCodelist.value[x] | required | GeslachtCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1From the FHIR Standard | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1From the FHIR Standard | ||||
| Patient.address.country.extension:countryCode.value[x] | required | LandCodelijstenhttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.10--20200901000000 | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipFrom the FHIR Standard | ||||
| Patient.contact.relationship:role | required | RolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 | ||||
| Patient.contact.relationship:relationship | required | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1From the FHIR Standard | ||||
| Patient.communication.extension:languageControl.extension:level.value[x] | required | LanguageAbilityProficiencyhttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency | ||||
| Patient.communication.extension:languageControl.extension:type.value[x] | preferred | LanguageAbilityModehttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode | ||||
| Patient.communication.language | required | CommunicatieTaalCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
| ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| houseNumberIndication | error | Patient.address.line.extension:houseNumberIndication.value[x] | Must have value 'by' or 'to' : $this in ('by' | 'to') | |
| kt2pnu-2 | error | Patient.name | Patient name use must not be empty : use.hasValue() | |
| 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() | |
| 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
Other representations of profile: CSV, Excel, Schematron
The identifier element is mandatory and should contain at least one identifier for the patient.
The active element is required and indicates whether the patient's record is in active use.
The name element is mandatory and follows Dutch naming conventions as defined in the zib NameInformation. The profile supports:
Required demographic elements include:
gender - Patient's gender (mandatory)birthDate - Patient's birth date (mandatory)When specified, the managingOrganization element must reference a KT2_Organization resource, indicating which organization is responsible for the patient's care.
The section on country codes is moved because it is equally relevant for Providers and Healthcare professionals.