Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-Patient | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibPatient | |||
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. In some care settings, the term client or participant is used instead of the term patient. Nationality is used as an indication of the country of citizenship. Marital status is a person’s formal position as defined by the Dutch civil code. There is a distinction between marriage and civil union. Linguistic proficiency is the ability to express oneself in a certain language and understand statements made in that language. This includes both oral and written communication.
This Patient resource represents the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) Patient v3.2 (2020). It also includes zib Nationality v3.0 (2020), zib MaritalStatus v3.1 (2020) and zib LanguageProficiency v3.2 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | Patient | This is an abstract profile. Child profiles: NlcorePatient Patient | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
  nationality | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
  extension:code | 0..1 | Extension | Extension | |
   extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
  value[x] | 1..1 | CodeableConcept | Nationality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 (extensible) | |
| extension:period | 0..1 | Extension | Nationality Period | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier | Σ | 0..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:$this |
 identifier:bsn | Σ | 0..* | Identifier | An identifier for this patient Required Pattern: At least the following |
  system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| Slices for name | Σ | 0..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use |
 name:nameInformation | C | 0..2 | ZibNameInformation | NameInformation |
 name:nameInformation-GivenName | 0..* | ZibNameInformationGivenName | Name of a human - parts and usage | |
| Slices for telecom | Σ | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this |
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers |
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses |
| gender | Σ | 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. |
 genderCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| value[x] | 0..1 | CodeableConcept | Gender Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 (required): GeslachtCodelijst | |
| birthDate | Σ | 0..1 | date | DateOfBirth |
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | DeathIndicator |
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | DateOfDeath |
| address | 0..* | ZibAddressInformation | AddressInformation | |
| maritalStatus | 0..1 | CodeableConcept | MaritalStatus Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 (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 | |
| contact | C | 0..* | BackboneElement | Contact |
| contactPerson | 0..1 | Reference(RelatedPerson) | This contact may have further details in this RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" | |
 value[x] | 1..1 | Reference(RelatedPerson | zib ContactPerson) | Contact | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for relationship | 0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| relationship:role | 0..* | CodeableConcept | Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required): RolCodelijst | |
| relationship:relationship | 0..* | CodeableConcept | Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required): RelatieCodelijst | |
| name | C | 0..1 | ZibNameInformation | NameInformation |
| Slices for telecom | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | |
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers |
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses |
 address | 0..1 | ZibAddressInformation | AddressInformation | |
| communication | 0..* | BackboneElement | LanguageProficiency | |
| languageControl | 0..* | (Complex) | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:level | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "level" | |
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (required) | |
| extension:type | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "type" | |
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityMode (preferred): The proficiency type for the communication. | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-proficiency" | |
| communicationDetails | 0..* | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.6--20200901000000 (extensible) | |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | Comment | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | CommunicationLanguage Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000 (required): CommunicatieTaalCodelijst | |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| 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() | |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | This is an abstract profile. Child profiles: 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| nationality | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:code | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "code" | |||||
| value[x] | 1..1 | CodeableConcept | Nationality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 (extensible) | |||||
| extension:period | 0..1 | Extension | Nationality Period | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "period" | |||||
| value[x] | 1..1 | Period | Value of extension | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | 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 | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name | Σ | 0..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
| name:nameInformation | C | 0..2 | ZibNameInformation | NameInformation | ||||
| name:nameInformation-GivenName | 0..* | ZibNameInformationGivenName | Name of a human - parts and usage | |||||
| Slices for telecom | Σ | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | ||||
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses | ||||
| gender | Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| genderCodelist | 0..1 | CodeableConcept | 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: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 (required): GeslachtCodelijst | |||||
| value | 0..1 | string | Primitive value for code | |||||
| birthDate | Σ | 0..1 | date | DateOfBirth | ||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | DeathIndicator | ||||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | DateOfDeath | ||||
| address | 0..* | ZibAddressInformation | AddressInformation | |||||
| maritalStatus | 0..1 | CodeableConcept | MaritalStatus Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 (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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| contactPerson | 0..1 | Reference(RelatedPerson) | This contact may have further details in this RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" | |||||
| value[x] | 1..1 | Reference(RelatedPerson | zib ContactPerson) | Contact | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| Slices for relationship | 0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| relationship:role | 0..* | CodeableConcept | Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required): RolCodelijst | |||||
| relationship:relationship | 0..* | CodeableConcept | Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required): RelatieCodelijst | |||||
| name | C | 0..1 | ZibNameInformation | NameInformation | ||||
| Slices for telecom | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | |||||
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses | ||||
| address | 0..1 | ZibAddressInformation | 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 | Extension Slice: Unordered, Open by value:url | |||||
| languageControl | 0..* | (Complex) | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:level | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "level" | |||||
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (required) | |||||
| extension:type | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "type" | |||||
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityMode (preferred): The proficiency type for the communication. | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-proficiency" | |||||
| communicationDetails | 0..* | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.6--20200901000000 (extensible) | |||||
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | Comment | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | CommunicationLanguage Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000 (required): CommunicatieTaalCodelijst | |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| 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() | |
| 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 Patient
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | This is an abstract profile. Child profiles: NlcorePatient Patient | |
| nationality | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
 extension:code | 0..1 | Extension | Extension | |
 value[x] | 1..1 | CodeableConcept | Nationality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 (extensible) | |
| Slices for identifier | 0..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:$this | |
| identifier:bsn | 0..* | Identifier | An identifier for this patient Required Pattern: At least the following | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | |
| Slices for name | 0..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | |
| name:nameInformation | 0..2 | ZibNameInformation | NameInformation | |
| name:nameInformation-GivenName | 0..* | ZibNameInformationGivenName | Name of a human - parts and usage | |
| Slices for telecom | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | |
| telecom:telephoneNumbers | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers | |
| telecom:emailAddresses | 0..* | ZibContactInformationEmailAddresses | EmailAddresses | |
| gender | 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. | |
| genderCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| value[x] | 0..1 | CodeableConcept | Gender Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 (required): GeslachtCodelijst | |
| birthDate | 0..1 | date | DateOfBirth | |
| Slices for deceased[x] | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
| deceased[x]:deceasedBoolean | 0..1 | boolean | DeathIndicator | |
| deceased[x]:deceasedDateTime | 0..1 | dateTime | DateOfDeath | |
| address | 0..* | ZibAddressInformation | AddressInformation | |
| maritalStatus | 0..1 | CodeableConcept | MaritalStatus Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 (required): BurgerlijkeStaatCodelijst | |
| Slices for multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this | |
| multipleBirth[x]:multipleBirthBoolean | 0..1 | boolean | MultipleBirthIndicator | |
| contact | 0..* | BackboneElement | Contact | |
| contactPerson | 0..1 | Reference(RelatedPerson) | This contact may have further details in this RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson | |
| value[x] | 1..1 | Reference(RelatedPerson | zib ContactPerson) | Contact | |
| Slices for relationship | 0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:$this | |
| relationship:role | 0..* | CodeableConcept | Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required): RolCodelijst | |
| relationship:relationship | 0..* | CodeableConcept | Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required): RelatieCodelijst | |
| name | 0..1 | ZibNameInformation | NameInformation | |
| Slices for telecom | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | |
| telecom:telephoneNumbers | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers | |
| telecom:emailAddresses | 0..* | ZibContactInformationEmailAddresses | EmailAddresses | |
| address | 0..1 | ZibAddressInformation | AddressInformation | |
| communication | 0..* | BackboneElement | LanguageProficiency | |
| languageControl | 0..* | (Complex) | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |
| extension | 2..* | Extension | Extension | |
| extension:level | 1..1 | Extension | Extension | |
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (required) | |
| extension:type | 1..1 | Extension | Extension | |
| communicationDetails | 0..* | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.6--20200901000000 (extensible) | |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| value[x] | 0..1 | string | Comment | |
| language | 1..1 | CodeableConcept | CommunicationLanguage Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000 (required): CommunicatieTaalCodelijst | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:nationality.extension:code.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 |
| Patient.gender | required | AdministrativeGender |
| Patient.gender.extension:genderCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 |
| Patient.maritalStatus | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 |
| Patient.contact.relationship:role | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 |
| Patient.contact.relationship:relationship | required | http://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 | LanguageAbilityProficiency |
| Patient.communication.language | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | This is an abstract profile. Child profiles: NlcorePatient Patient | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| nationality | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |
| extension:code | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
| value[x] | 1..1 | CodeableConcept | Nationality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 (extensible) | |
| extension:period | 0..1 | Extension | Nationality Period | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| value[x] | 1..1 | Period | Value of extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 0..* | Identifier | PatientIdentificationNumber Slice: Unordered, Open by value:$this |
| identifier:bsn | Σ | 0..* | Identifier | An identifier for this patient Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn | |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| Slices for name | Σ | 0..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use |
| name:nameInformation | C | 0..2 | ZibNameInformation | NameInformation |
| name:nameInformation-GivenName | 0..* | ZibNameInformationGivenName | Name of a human - parts and usage | |
| Slices for telecom | Σ | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this |
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers |
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses |
| gender | Σ | 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. |
| genderCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| value[x] | 0..1 | CodeableConcept | Gender Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 (required): GeslachtCodelijst | |
| birthDate | Σ | 0..1 | date | DateOfBirth |
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | DeathIndicator |
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | DateOfDeath |
| address | 0..* | ZibAddressInformation | AddressInformation | |
| maritalStatus | 0..1 | CodeableConcept | MaritalStatus Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 (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 | |
| contact | C | 0..* | BackboneElement | Contact |
| contactPerson | 0..1 | Reference(RelatedPerson) | This contact may have further details in this RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" | |
| value[x] | 1..1 | Reference(RelatedPerson | zib ContactPerson) | Contact | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for relationship | 0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
| relationship:role | 0..* | CodeableConcept | Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required): RolCodelijst | |
| relationship:relationship | 0..* | CodeableConcept | Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required): RelatieCodelijst | |
| name | C | 0..1 | ZibNameInformation | NameInformation |
| Slices for telecom | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | |
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers |
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses |
| address | 0..1 | ZibAddressInformation | AddressInformation | |
| communication | 0..* | BackboneElement | LanguageProficiency | |
| languageControl | 0..* | (Complex) | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:level | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "level" | |
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (required) | |
| extension:type | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "type" | |
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityMode (preferred): The proficiency type for the communication. | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-proficiency" | |
| communicationDetails | 0..* | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.6--20200901000000 (extensible) | |
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | Comment | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | CommunicationLanguage Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000 (required): CommunicatieTaalCodelijst | |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:nationality.extension:code.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 |
| Patient.gender | required | AdministrativeGender |
| Patient.gender.extension:genderCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 |
| Patient.maritalStatus | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 |
| Patient.contact.relationship | extensible | PatientContactRelationship |
| Patient.contact.relationship:role | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 |
| Patient.contact.relationship:relationship | required | http://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 | LanguageAbilityProficiency |
| Patient.communication.extension:languageControl.extension:type.value[x] | preferred | LanguageAbilityMode |
| Patient.communication.language | required | http://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 | LinkType |
| 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() | |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | This is an abstract profile. Child profiles: 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| nationality | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:code | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "code" | |||||
| value[x] | 1..1 | CodeableConcept | Nationality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 (extensible) | |||||
| extension:period | 0..1 | Extension | Nationality Period | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "period" | |||||
| value[x] | 1..1 | Period | Value of extension | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | 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 | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| Slices for name | Σ | 0..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
| name:nameInformation | C | 0..2 | ZibNameInformation | NameInformation | ||||
| name:nameInformation-GivenName | 0..* | ZibNameInformationGivenName | Name of a human - parts and usage | |||||
| Slices for telecom | Σ | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | ||||
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses | ||||
| gender | Σ | 0..1 | code | Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| genderCodelist | 0..1 | CodeableConcept | 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: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 (required): GeslachtCodelijst | |||||
| value | 0..1 | string | Primitive value for code | |||||
| birthDate | Σ | 0..1 | date | DateOfBirth | ||||
| Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| deceased[x]:deceasedBoolean | ?!Σ | 0..1 | boolean | DeathIndicator | ||||
| deceased[x]:deceasedDateTime | ?!Σ | 0..1 | dateTime | DateOfDeath | ||||
| address | 0..* | ZibAddressInformation | AddressInformation | |||||
| maritalStatus | 0..1 | CodeableConcept | MaritalStatus Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 (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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| contactPerson | 0..1 | Reference(RelatedPerson) | This contact may have further details in this RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-relatedPerson" | |||||
| value[x] | 1..1 | Reference(RelatedPerson | zib ContactPerson) | Contact | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| Slices for relationship | 0..* | CodeableConcept | The kind of relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| relationship:role | 0..* | CodeableConcept | Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required): RolCodelijst | |||||
| relationship:relationship | 0..* | CodeableConcept | Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required): RelatieCodelijst | |||||
| name | C | 0..1 | ZibNameInformation | NameInformation | ||||
| Slices for telecom | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | |||||
| telecom:telephoneNumbers | C | 0..* | ZibContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | ZibContactInformationEmailAddresses | EmailAddresses | ||||
| address | 0..1 | ZibAddressInformation | 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 | Extension Slice: Unordered, Open by value:url | |||||
| languageControl | 0..* | (Complex) | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:level | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "level" | |||||
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityProficiency (required) | |||||
| extension:type | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "type" | |||||
| value[x] | 1..1 | Coding | Value of extension Binding: LanguageAbilityMode (preferred): The proficiency type for the communication. | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-proficiency" | |||||
| communicationDetails | 0..* | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.6--20200901000000 (extensible) | |||||
| comment | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | Comment | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | CommunicationLanguage Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000 (required): CommunicatieTaalCodelijst | |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.extension:nationality.extension:code.value[x] | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.gender.extension:genderCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000 | ||||
| Patient.maritalStatus | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000 | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.relationship:role | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 | ||||
| Patient.contact.relationship:relationship | required | http://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 | AdministrativeGender | ||||
| Patient.communication.extension:languageControl.extension:level.value[x] | required | LanguageAbilityProficiency | ||||
| Patient.communication.extension:languageControl.extension:type.value[x] | preferred | LanguageAbilityMode | ||||
| Patient.communication.language | required | http://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 | LinkType |
| 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() | |
| 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 Patient
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron