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
| Draft as of 2023-10-17 |
Definitions for the zib-Patient resource profile.
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |
| Short | Patient |
| Alternate Names | Patient |
| LOINC Code | |
| 2. Patient.extension:nationality | |
| Slice Name | nationality |
| Comments | Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the zib cardinality of 0..1. |
| Control | 0..1 |
| Type | Extension(nationality) (Complex Extension) |
| 4. Patient.extension:nationality.extension:code | |
| Slice Name | code |
| 6. Patient.extension:nationality.extension:code.value[x] | |
| Definition | Indicates the country of citizenship. |
| Short | Nationality |
| Binding | Unless not suitable, these codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | Nationaliteit |
| 8. Patient.identifier | |
| Definition | The patient’s identification number. In transfer situations, use of the social security number (BSN) must comply with the Use of Social Security Numbers in Healthcare Act (Wbsn-z). In other situations, other number systems can be used, such as internal hospital patient numbers for example. |
| Short | PatientIdentificationNumber |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Alternate Names | Identificatienummer |
| LOINC Code | |
| Slicing | This element introduces a set of slices on Patient.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 10. Patient.identifier:bsn | |
| Slice Name | bsn |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"><br/> <system value="http://fhir.nl/fhir/NamingSystem/bsn"/><br/></valueIdentifier><br/> |
| 12. Patient.name | |
| Definition | Patient's full name. |
| Short | NameInformation / PayerName |
| Alternate Names | Naamgegevens, BetalerNaam |
| LOINC Code | |
| Slicing | This element introduces a set of slices on Patient.name. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 14. Patient.name:nameInformation | |
| Slice Name | nameInformation |
| Control | 0..2 |
| Type | HumanName(zib NameInformation) |
| 16. Patient.name:nameInformation-GivenName | |
| Slice Name | nameInformation-GivenName |
| Type | HumanName(zib NameInformation.GivenName) |
| 18. Patient.telecom | |
| Definition | Patient’s telephone number(s) or e-mail address(es). |
| Short | ContactInformation |
| Comments | The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. |
| Alternate Names | Contactgegevens |
| LOINC Code | |
| Slicing | This element introduces a set of slices on Patient.telecom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 20. Patient.telecom:telephoneNumbers | |
| Slice Name | telephoneNumbers |
| Type | ContactPoint(zib ContactInformation TelephoneNumbers) |
| 22. Patient.telecom:emailAddresses | |
| Slice Name | emailAddresses |
| Type | ContactPoint(zib ContactInformation EmailAddresses) |
| 24. Patient.gender | |
| Definition | Patient’s administrative gender. |
| Short | Gender |
| Binding | The codes SHALL be taken from AdministrativeGender: Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. |
| Alternate Names | Geslacht |
| LOINC Code | |
| 26. Patient.gender.extension:genderCodelist | |
| Slice Name | genderCodelist |
| Control | 0..1 |
| Type | Extension(ext CodeSpecification) (Extension Type: CodeableConcept) |
| 28. Patient.gender.extension:genderCodelist.value[x] | |
| Definition | Patient’s administrative gender. |
| Short | Gender |
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000: GeslachtCodelijst |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | Geslacht |
| 30. Patient.birthDate | |
| Definition | Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted. |
| Short | DateOfBirth |
| Alternate Names | Geboortedatum |
| LOINC Code | |
| 32. Patient.deceased[x] | |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| LOINC Code | |
| Slicing | This element introduces a set of slices on Patient.deceased[x]. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 34. Patient.deceased[x]:deceasedBoolean | |
| Slice Name | deceasedBoolean |
| Definition | An indication stating whether the patient has died. |
| Short | DeathIndicator |
| Type | boolean |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | OverlijdensIndicator |
| 36. Patient.deceased[x]:deceasedDateTime | |
| Slice Name | deceasedDateTime |
| Definition | The date on which the patient died. A ‘vague’ date, such as only the year, is permitted. |
| Short | DateOfDeath |
| Comments | The zib recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true. |
| Type | dateTime |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | DatumOverlijden, OverlijdensIndicator |
| 38. Patient.address | |
| Definition | Patient's address information. |
| Type | Address(zib AddressInformation) |
| LOINC Code | |
| 40. Patient.maritalStatus | |
| Definition | A person’s marital status according to the terms and definition in the Dutch civil code. |
| Short | MaritalStatus |
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000: BurgerlijkeStaatCodelijst |
| Alternate Names | BurgerlijkeStaat |
| LOINC Code | |
| 42. Patient.multipleBirth[x] | |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| LOINC Code | |
| Slicing | This element introduces a set of slices on Patient.multipleBirth[x]. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 44. Patient.multipleBirth[x]:multipleBirthBoolean | |
| Slice Name | multipleBirthBoolean |
| Definition | An indication stating whether the patient is of a multiple birth. |
| Short | MultipleBirthIndicator |
| Type | boolean |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Alternate Names | MeerlingIndicator |
| 46. Patient.contact | |
| Short | Contact |
| Comments | Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: |
| Alternate Names | Contactpersoon |
| LOINC Code | |
| 48. Patient.contact.extension:contactPerson | |
| Slice Name | contactPerson |
| Control | 0..1 |
| Type | Extension(relatedPerson) (Extension Type: Reference(RelatedPerson)) |
| 50. Patient.contact.extension:contactPerson.value[x] | |
| Definition | Reference to a zib-ContactPerson instance containing the full details for the current contact. |
| Short | Contact |
| Type | Reference(RelatedPerson, zib ContactPerson) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | Contactpersoon |
| 52. Patient.contact.relationship | |
| LOINC Code | |
| Slicing | This element introduces a set of slices on Patient.contact.relationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 54. Patient.contact.relationship:role | |
| Slice Name | role |
| Definition | Defines the role of the contact in relation to the patient. |
| Short | Role |
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000: RolCodelijst |
| Alternate Names | Rol |
| 56. Patient.contact.relationship:relationship | |
| Slice Name | relationship |
| Definition | Defines the contact’s familial relationship to the patient. |
| Short | Relationship |
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000: RelatieCodelijst |
| Alternate Names | Relatie |
| 58. Patient.contact.name | |
| Definition | Full name of the contact. |
| Comments | This element can and should not completely capture the NameInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full name information should instead be captured using an instance of zib-ContactPerson, which can then be referenced from this resource. See the comment on |
| Type | HumanName(zib NameInformation) |
| LOINC Code | |
| 60. Patient.contact.telecom | |
| Definition | The contact’s telephone number and/or e-mail address. |
| Short | ContactInformation |
| Comments | The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. |
| Alternate Names | Contactgegevens |
| LOINC Code | |
| Slicing | This element introduces a set of slices on Patient.contact.telecom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 62. Patient.contact.telecom:telephoneNumbers | |
| Slice Name | telephoneNumbers |
| Type | ContactPoint(zib ContactInformation TelephoneNumbers) |
| 64. Patient.contact.telecom:emailAddresses | |
| Slice Name | emailAddresses |
| Type | ContactPoint(zib ContactInformation EmailAddresses) |
| 66. Patient.contact.address | |
| Definition | Contact’s address information. |
| Comments | This element can and should not completely capture the AddressInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of zib-ContactPerson, which can then be referenced from this resource. See the comment on |
| Type | Address(zib AddressInformation) |
| LOINC Code | |
| 68. Patient.communication | |
| Short | LanguageProficiency |
| Alternate Names | Taalvaardigheid |
| LOINC Code | |
| 70. Patient.communication.extension:languageControl | |
| Slice Name | languageControl |
| Definition | The ability to understand spoken text in the language in question. The ability to express oneself in spoken language. The ability to understand written text in he language in question. |
| Short | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading |
| Comments | The zib concepts LanguageControlListening, LanguageControlReading, LanguageControlSpeaking are captured using a core extension from the R4 FHIR specification. Each of these three concepts is encoded as a copy of the extension, typed using the code in the type slice according to the following mapping: |
| Type | Extension(proficiency) (Complex Extension) |
| Alternate Names | TaalvaardigheidBegrijpen, TaalvaardigheidSpreken, TaalvaardigheidLezen |
| 72. Patient.communication.extension:languageControl.extension | |
| Control | 2..? |
| 74. Patient.communication.extension:languageControl.extension:level | |
| Slice Name | level |
| Control | 1..? |
| 76. Patient.communication.extension:languageControl.extension:level.value[x] | |
| Comments | The zib ValueSets TaalvaardigheidBegrijpenCodelijst, TaalvaardigheidSprekenCodelijst and TaalvaardigheidLezenCodelijst are equal to the default FHIR ValueSet. |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 78. Patient.communication.extension:languageControl.extension:type | |
| Slice Name | type |
| Control | 1..1 |
| 80. Patient.communication.extension:communicationDetails | |
| Slice Name | communicationDetails |
| Type | Extension(ext LanguageProficiency.CommunicationDetails) (Extension Type: CodeableConcept) |
| 82. Patient.communication.extension:comment | |
| Slice Name | comment |
| Control | 0..1 |
| Type | Extension(ext Comment) (Extension Type: string) |
| 84. Patient.communication.extension:comment.value[x] | |
| Definition | A comment on the linguistic proficiency. When using sign language, this field can be used to clarify, for example, which sign language is used. This can be informative, as there is not always a one-to-one relationship between the spoken language and sign language. |
| Short | Comment |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Alternate Names | Toelichting |
| 86. Patient.communication.language | |
| Definition | The language of communication. |
| Short | CommunicationLanguage |
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000: CommunicatieTaalCodelijst |
| Alternate Names | CommunicatieTaal |
| LOINC Code | |
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |||||||||||||||||||||||||||||
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||||||||||||||||||||||||||||
| Short | PatientInformation about an individual or animal receiving health care services | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | SubjectOfCare Client Resident, Patient | ||||||||||||||||||||||||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) | ||||||||||||||||||||||||||||
| 2. Patient.implicitRules | |||||||||||||||||||||||||||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||||||||||||||||||
| Short | A set of rules under which this content was created | ||||||||||||||||||||||||||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 4. Patient.extension:nationality | |||||||||||||||||||||||||||||
| Slice Name | nationality | ||||||||||||||||||||||||||||
| Definition | The nationality of the patient. | ||||||||||||||||||||||||||||
| Short | Nationality | ||||||||||||||||||||||||||||
| Comments | Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the zib cardinality of 0..1. | ||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Extension(nationality) (Complex Extension) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| LOINC Code | |||||||||||||||||||||||||||||
| 6. Patient.extension:nationality.extension:code | |||||||||||||||||||||||||||||
| Slice Name | code | ||||||||||||||||||||||||||||
| Definition | An Extension | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Control | 0..1* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 8. Patient.extension:nationality.extension:code.extension | |||||||||||||||||||||||||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..0* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 10. Patient.extension:nationality.extension:code.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | code | ||||||||||||||||||||||||||||
| 12. Patient.extension:nationality.extension:code.value[x] | |||||||||||||||||||||||||||||
| Definition | Indicates the country of citizenship. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | NationalityValue of extension | ||||||||||||||||||||||||||||
| Control | 10..1 | ||||||||||||||||||||||||||||
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 | ||||||||||||||||||||||||||||
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | Nationaliteit | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 14. Patient.extension:nationality.extension:period | |||||||||||||||||||||||||||||
| Slice Name | period | ||||||||||||||||||||||||||||
| Definition | Period when nationality was effective. | ||||||||||||||||||||||||||||
| Short | Nationality PeriodAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Control | 0..1* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 16. Patient.extension:nationality.extension:period.extension | |||||||||||||||||||||||||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..0* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 18. Patient.extension:nationality.extension:period.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | period | ||||||||||||||||||||||||||||
| 20. Patient.extension:nationality.extension:period.value[x] | |||||||||||||||||||||||||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | Value of extension | ||||||||||||||||||||||||||||
| Control | 10..1 | ||||||||||||||||||||||||||||
| Type | Period, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 22. Patient.extension:nationality.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-nationality | ||||||||||||||||||||||||||||
| 24. Patient.extension:nationality.value[x] | |||||||||||||||||||||||||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | Value of extension | ||||||||||||||||||||||||||||
| Control | 0..01 | ||||||||||||||||||||||||||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 26. Patient.modifierExtension | |||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 28. Patient.identifier | |||||||||||||||||||||||||||||
| Definition | The patient’s identification number. In transfer situations, use of the social security number (BSN) must comply with the Use of Social Security Numbers in Healthcare Act (Wbsn-z). In other situations, other number systems can be used, such as internal hospital patient numbers for example. An identifier for this patient. | ||||||||||||||||||||||||||||
| Short | PatientIdentificationNumberAn identifier for this patient | ||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | Identifier | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||||||||||||||||||||||
| Alternate Names | Identificatienummer | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 30. Patient.identifier:bsn | |||||||||||||||||||||||||||||
| Slice Name | bsn | ||||||||||||||||||||||||||||
| Definition | An identifier for this patient. | ||||||||||||||||||||||||||||
| Short | An identifier for this patient | ||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | Identifier | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||||||||||||||||||||||||||
| Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"><br/> <system value="http://fhir.nl/fhir/NamingSystem/bsn"/><br/></valueIdentifier><br/> | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 32. Patient.active | |||||||||||||||||||||||||||||
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. | ||||||||||||||||||||||||||||
| Short | Whether this patient's record is in active use | ||||||||||||||||||||||||||||
| Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | boolean | ||||||||||||||||||||||||||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||||||||||||||||||||||||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 34. Patient.name | |||||||||||||||||||||||||||||
| Definition | Patient's full name. A name associated with the individual. | ||||||||||||||||||||||||||||
| Short | NameInformation / PayerNameA name associated with the patient | ||||||||||||||||||||||||||||
| Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | HumanName | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||||||||||||||||||||||||||
| Alternate Names | Naamgegevens, BetalerNaam | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.name. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 36. Patient.name:nameInformation | |||||||||||||||||||||||||||||
| Slice Name | nameInformation | ||||||||||||||||||||||||||||
| Definition | This slice represents the person's official name information, including given names, last name and possibly the partner's last name. A name associated with the individual. | ||||||||||||||||||||||||||||
| Short | NameInformationA name associated with the patient | ||||||||||||||||||||||||||||
| Comments | This Note 1: The zib cannot be represented straightforward in FHIR. Especially note the guidance on Note 2: This element should only contain a person's official names. The GivenName concept is represented in another Note 3: The examples illustrate how the zib is mapped to FHIR. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. | ||||||||||||||||||||||||||||
| Control | 0..2* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | HumanName(zib NameInformation) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||||||||||||||||||||||||||
| Alternate Names | Naamgegevens | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) zib-NameInformation-1: 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: 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()) | ||||||||||||||||||||||||||||
| 38. Patient.name:nameInformation-GivenName | |||||||||||||||||||||||||||||
| Slice Name | nameInformation-GivenName | ||||||||||||||||||||||||||||
| Definition | This slice represents the name information normally used to address the person. A name associated with the individual. | ||||||||||||||||||||||||||||
| Short | Name of a human - parts and usageA name associated with the patient | ||||||||||||||||||||||||||||
| Comments | This Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other Note 2: The examples illustrate how the zib is mapped to FHIR. A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | HumanName(zib NameInformation.GivenName) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 40. Patient.telecom | |||||||||||||||||||||||||||||
| Definition | Patient’s telephone number(s) or e-mail address(es). A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||||||||||||||||||||||||||||
| Short | ContactInformationA contact detail for the individual | ||||||||||||||||||||||||||||
| Comments | The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | ContactPoint | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||||||||||||||||||||||||
| Alternate Names | Contactgegevens | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.telecom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 42. Patient.telecom:telephoneNumbers | |||||||||||||||||||||||||||||
| Slice Name | telephoneNumbers | ||||||||||||||||||||||||||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||||||||||||||||||||||||||||
| Short | TelephoneNumbersA contact detail for the individual | ||||||||||||||||||||||||||||
| Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | ContactPoint(zib ContactInformation TelephoneNumbers) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||||||||||||||||||||||||
| Alternate Names | Telefoonnummers | ||||||||||||||||||||||||||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 44. Patient.telecom:emailAddresses | |||||||||||||||||||||||||||||
| Slice Name | emailAddresses | ||||||||||||||||||||||||||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. | ||||||||||||||||||||||||||||
| Short | EmailAddressesA contact detail for the individual | ||||||||||||||||||||||||||||
| Comments | Implementation of the "EmailAddresses" concept of zib ContactInformation. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | ContactPoint(zib ContactInformation EmailAddresses) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||||||||||||||||||||||||
| Alternate Names | EmailAdressen | ||||||||||||||||||||||||||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 46. Patient.gender | |||||||||||||||||||||||||||||
| Definition | Patient’s administrative gender. Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. | ||||||||||||||||||||||||||||
| Short | Gendermale | female | other | unknown | ||||||||||||||||||||||||||||
| Comments | The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. The gender of a person used for administrative purposes. | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||||||||||||||||||||||||||
| Alternate Names | Geslacht | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 48. Patient.gender.extension:genderCodelist | |||||||||||||||||||||||||||||
| Slice Name | genderCodelist | ||||||||||||||||||||||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||||||||||||||||||||||
| Short | Optional Extensions Element | ||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Extension(ext CodeSpecification) (Extension Type: CodeableConcept) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| LOINC Code | |||||||||||||||||||||||||||||
| 50. Patient.gender.extension:genderCodelist.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | ||||||||||||||||||||||||||||
| 52. Patient.gender.extension:genderCodelist.value[x] | |||||||||||||||||||||||||||||
| Definition | Patient’s administrative gender. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | GenderValue of extension | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from For codes, see http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000: GeslachtCodelijst | ||||||||||||||||||||||||||||
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | Geslacht | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 54. Patient.birthDate | |||||||||||||||||||||||||||||
| Definition | Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted. The date of birth for the individual. | ||||||||||||||||||||||||||||
| Short | DateOfBirthThe date of birth for the individual | ||||||||||||||||||||||||||||
| Comments | At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | date | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Age of the individual drives many clinical processes. | ||||||||||||||||||||||||||||
| Alternate Names | Geboortedatum | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| LOINC Code | 21112-8 | ||||||||||||||||||||||||||||
| 56. Patient.deceased[x] | |||||||||||||||||||||||||||||
| Definition | Indicates if the individual is deceased or not. | ||||||||||||||||||||||||||||
| Short | Indicates if the individual is deceased or not | ||||||||||||||||||||||||||||
| Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | Choice of: boolean, dateTime | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.deceased[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 58. Patient.deceased[x]:deceasedBoolean | |||||||||||||||||||||||||||||
| Slice Name | deceasedBoolean | ||||||||||||||||||||||||||||
| Definition | An indication stating whether the patient has died. Indicates if the individual is deceased or not. | ||||||||||||||||||||||||||||
| Short | DeathIndicatorIndicates if the individual is deceased or not | ||||||||||||||||||||||||||||
| Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | boolean, dateTime | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||||||||||||||||||||||||||
| Alternate Names | OverlijdensIndicator | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 60. Patient.deceased[x]:deceasedDateTime | |||||||||||||||||||||||||||||
| Slice Name | deceasedDateTime | ||||||||||||||||||||||||||||
| Definition | The date on which the patient died. A ‘vague’ date, such as only the year, is permitted. Indicates if the individual is deceased or not. | ||||||||||||||||||||||||||||
| Short | DateOfDeathIndicates if the individual is deceased or not | ||||||||||||||||||||||||||||
| Comments | The zib recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true. If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | dateTime, boolean | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||||||||||||||||||||||||||
| Alternate Names | DatumOverlijden, OverlijdensIndicator | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 62. Patient.address | |||||||||||||||||||||||||||||
| Definition | Patient's address information. An address for the individual. | ||||||||||||||||||||||||||||
| Short | AddressInformationAn address for the individual | ||||||||||||||||||||||||||||
| Comments | This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the zib AddressInformation v1.1 (2020). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements. Separate address parts The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad. Custom address types The second addition is that the zib defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the zib concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The code from the zib should also be included using the extension on
If Note: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the zib ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension. Patient may have multiple addresses with different uses or applicable periods. | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Address(zib AddressInformation) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||||||||||||||||||||||||||
| Alternate Names | Adresgegevens | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 64. Patient.maritalStatus | |||||||||||||||||||||||||||||
| Definition | A person’s marital status according to the terms and definition in the Dutch civil code. This field contains a patient's most recent marital (civil) status. | ||||||||||||||||||||||||||||
| Short | MaritalStatusMarital (civil) status of a patient | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000http://hl7.org/fhir/ValueSet/marital-status BurgerlijkeStaatCodelijst The domestic partnership status of a person. | ||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | Most, if not all systems capture it. | ||||||||||||||||||||||||||||
| Alternate Names | BurgerlijkeStaat | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 66. Patient.multipleBirth[x] | |||||||||||||||||||||||||||||
| Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||||||||||||||||||||||||||
| Short | Whether patient is part of a multiple birth | ||||||||||||||||||||||||||||
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | Choice of: boolean, integer | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.multipleBirth[x]. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 68. Patient.multipleBirth[x]:multipleBirthBoolean | |||||||||||||||||||||||||||||
| Slice Name | multipleBirthBoolean | ||||||||||||||||||||||||||||
| Definition | An indication stating whether the patient is of a multiple birth. Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||||||||||||||||||||||||||
| Short | MultipleBirthIndicatorWhether patient is part of a multiple birth | ||||||||||||||||||||||||||||
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | boolean, integer | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||||||||||||||||||||||||||
| Alternate Names | MeerlingIndicator | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 70. Patient.contact | |||||||||||||||||||||||||||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||||||||||||||||||||||||||
| Short | ContactA contact party (e.g. guardian, partner, friend) for the patient | ||||||||||||||||||||||||||||
| Comments | Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:
If a person is both a related person and a contact person, then some data duplication is inevitable. The zib-ContactPerson can be referenced using the extension in Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | BackboneElement | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | Need to track people you can contact about the patient. | ||||||||||||||||||||||||||||
| Alternate Names | Contactpersoon | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pat-1: 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())pat-1: 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()) | ||||||||||||||||||||||||||||
| 72. Patient.contact.extension:contactPerson | |||||||||||||||||||||||||||||
| Slice Name | contactPerson | ||||||||||||||||||||||||||||
| Definition | In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. | ||||||||||||||||||||||||||||
| Short | This contact may have further details in this RelatedPerson | ||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Extension(relatedPerson) (Extension Type: Reference(RelatedPerson)) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| LOINC Code | |||||||||||||||||||||||||||||
| 74. Patient.contact.extension:contactPerson.extension | |||||||||||||||||||||||||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..0* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.contact.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 76. Patient.contact.extension:contactPerson.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-relatedPerson | ||||||||||||||||||||||||||||
| 78. Patient.contact.extension:contactPerson.value[x] | |||||||||||||||||||||||||||||
| Definition | Reference to a zib-ContactPerson instance containing the full details for the current contact. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | ContactValue of extension | ||||||||||||||||||||||||||||
| Control | 10..1 | ||||||||||||||||||||||||||||
| Type | Reference(RelatedPerson, zib ContactPerson), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | Contactpersoon | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 80. Patient.contact.modifierExtension | |||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 82. Patient.contact.relationship | |||||||||||||||||||||||||||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||||||||||||||||||||||||||
| Short | The kind of relationship | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship The nature of the relationship between a patient and a contact person for that patient. | ||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.contact.relationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 84. Patient.contact.relationship:role | |||||||||||||||||||||||||||||
| Slice Name | role | ||||||||||||||||||||||||||||
| Definition | Defines the role of the contact in relation to the patient. The nature of the relationship between the patient and the contact person. | ||||||||||||||||||||||||||||
| Short | RoleThe kind of relationship | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000http://hl7.org/fhir/ValueSet/patient-contactrelationship RolCodelijst The nature of the relationship between a patient and a contact person for that patient. | ||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||||||||||||||||||||||
| Alternate Names | Rol | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 86. Patient.contact.relationship:relationship | |||||||||||||||||||||||||||||
| Slice Name | relationship | ||||||||||||||||||||||||||||
| Definition | Defines the contact’s familial relationship to the patient. The nature of the relationship between the patient and the contact person. | ||||||||||||||||||||||||||||
| Short | RelationshipThe kind of relationship | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000http://hl7.org/fhir/ValueSet/patient-contactrelationship RelatieCodelijst The nature of the relationship between a patient and a contact person for that patient. | ||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||||||||||||||||||||||||||
| Alternate Names | Relatie | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 88. Patient.contact.name | |||||||||||||||||||||||||||||
| Definition | Full name of the contact. A name associated with the contact person. | ||||||||||||||||||||||||||||
| Short | NameInformationA name associated with the contact person | ||||||||||||||||||||||||||||
| Comments | This element can and should not completely capture the NameInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full name information should instead be captured using an instance of zib-ContactPerson, which can then be referenced from this resource. See the comment on | ||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | HumanName(zib NameInformation) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||||||||||||||||||||||||||
| Alternate Names | Naamgegevens | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) zib-NameInformation-1: 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: 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()) | ||||||||||||||||||||||||||||
| 90. Patient.contact.telecom | |||||||||||||||||||||||||||||
| Definition | The contact’s telephone number and/or e-mail address. A contact detail for the person, e.g. a telephone number or an email address. | ||||||||||||||||||||||||||||
| Short | ContactInformationA contact detail for the person | ||||||||||||||||||||||||||||
| Comments | The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | ContactPoint | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||||||||||||||||||||||||
| Alternate Names | Contactgegevens | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.contact.telecom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 92. Patient.contact.telecom:telephoneNumbers | |||||||||||||||||||||||||||||
| Slice Name | telephoneNumbers | ||||||||||||||||||||||||||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail for the person, e.g. a telephone number or an email address. | ||||||||||||||||||||||||||||
| Short | TelephoneNumbersA contact detail for the person | ||||||||||||||||||||||||||||
| Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. Please note that, although the zib concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | ContactPoint(zib ContactInformation TelephoneNumbers) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||||||||||||||||||||||||
| Alternate Names | Telefoonnummers | ||||||||||||||||||||||||||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 94. Patient.contact.telecom:emailAddresses | |||||||||||||||||||||||||||||
| Slice Name | emailAddresses | ||||||||||||||||||||||||||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. A contact detail for the person, e.g. a telephone number or an email address. | ||||||||||||||||||||||||||||
| Short | EmailAddressesA contact detail for the person | ||||||||||||||||||||||||||||
| Comments | Implementation of the "EmailAddresses" concept of zib ContactInformation. Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | ContactPoint(zib ContactInformation EmailAddresses) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||||||||||||||||||||||||
| Alternate Names | EmailAdressen | ||||||||||||||||||||||||||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 96. Patient.contact.address | |||||||||||||||||||||||||||||
| Definition | Contact’s address information. Address for the contact person. | ||||||||||||||||||||||||||||
| Short | AddressInformationAddress for the contact person | ||||||||||||||||||||||||||||
| Comments | This element can and should not completely capture the AddressInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of zib-ContactPerson, which can then be referenced from this resource. See the comment on | ||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Address(zib AddressInformation) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||||||||||||||||||||||||||
| Alternate Names | Adresgegevens | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 98. Patient.communication | |||||||||||||||||||||||||||||
| Definition | A language which may be used to communicate with the patient about his or her health. | ||||||||||||||||||||||||||||
| Short | LanguageProficiencyA language which may be used to communicate with the patient about his or her health | ||||||||||||||||||||||||||||
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | BackboneElement | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. | ||||||||||||||||||||||||||||
| Alternate Names | Taalvaardigheid | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 100. Patient.communication.extension:languageControl | |||||||||||||||||||||||||||||
| Slice Name | languageControl | ||||||||||||||||||||||||||||
| Definition | The ability to understand spoken text in the language in question. The ability to express oneself in spoken language. The ability to understand written text in he language in question. | ||||||||||||||||||||||||||||
| Short | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading | ||||||||||||||||||||||||||||
| Comments | The zib concepts LanguageControlListening, LanguageControlReading, LanguageControlSpeaking are captured using a core extension from the R4 FHIR specification. Each of these three concepts is encoded as a copy of the extension, typed using the code in the type slice according to the following mapping: | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Extension(proficiency) (Complex Extension) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Alternate Names | TaalvaardigheidBegrijpen, TaalvaardigheidSpreken, TaalvaardigheidLezen | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| LOINC Code | |||||||||||||||||||||||||||||
| 102. Patient.communication.extension:languageControl.extension | |||||||||||||||||||||||||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 20..* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.communication.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 104. Patient.communication.extension:languageControl.extension:level | |||||||||||||||||||||||||||||
| Slice Name | level | ||||||||||||||||||||||||||||
| Definition | An Extension | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Control | 10..1* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 106. Patient.communication.extension:languageControl.extension:level.extension | |||||||||||||||||||||||||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..0* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.communication.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 108. Patient.communication.extension:languageControl.extension:level.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | level | ||||||||||||||||||||||||||||
| 110. Patient.communication.extension:languageControl.extension:level.value[x] | |||||||||||||||||||||||||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | Value of extension | ||||||||||||||||||||||||||||
| Comments | The zib ValueSets TaalvaardigheidBegrijpenCodelijst, TaalvaardigheidSprekenCodelijst and TaalvaardigheidLezenCodelijst are equal to the default FHIR ValueSet. | ||||||||||||||||||||||||||||
| Control | 10..1 | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from For codes, see LanguageAbilityProficiency | ||||||||||||||||||||||||||||
| Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 112. Patient.communication.extension:languageControl.extension:type | |||||||||||||||||||||||||||||
| Slice Name | type | ||||||||||||||||||||||||||||
| Definition | An Extension | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Control | 10..1* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 114. Patient.communication.extension:languageControl.extension:type.extension | |||||||||||||||||||||||||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..0* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Patient.communication.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||||||||||||||||||||||||||
| 116. Patient.communication.extension:languageControl.extension:type.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | type | ||||||||||||||||||||||||||||
| 118. Patient.communication.extension:languageControl.extension:type.value[x] | |||||||||||||||||||||||||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | Value of extension | ||||||||||||||||||||||||||||
| Control | 10..1 | ||||||||||||||||||||||||||||
| Binding | The codes SHOULD be taken from For codes, see LanguageAbilityMode: The proficiency type for the communication. | ||||||||||||||||||||||||||||
| Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 120. Patient.communication.extension:languageControl.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-proficiency | ||||||||||||||||||||||||||||
| 122. Patient.communication.extension:languageControl.value[x] | |||||||||||||||||||||||||||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | Value of extension | ||||||||||||||||||||||||||||
| Control | 0..01 | ||||||||||||||||||||||||||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 124. Patient.communication.extension:communicationDetails | |||||||||||||||||||||||||||||
| Slice Name | communicationDetails | ||||||||||||||||||||||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||||||||||||||||||||||
| Short | Optional Extensions Element | ||||||||||||||||||||||||||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Extension(ext LanguageProficiency.CommunicationDetails) (Extension Type: CodeableConcept) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| LOINC Code | |||||||||||||||||||||||||||||
| 126. Patient.communication.extension:comment | |||||||||||||||||||||||||||||
| Slice Name | comment | ||||||||||||||||||||||||||||
| Definition | Optional Extension Element - found in all resources. | ||||||||||||||||||||||||||||
| Short | Optional Extensions Element | ||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||||||||||||||||||
| Type | Extension(ext Comment) (Extension Type: string) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| LOINC Code | |||||||||||||||||||||||||||||
| 128. Patient.communication.extension:comment.url | |||||||||||||||||||||||||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||||||||||||||||||||||||
| Short | identifies the meaning of the extension | ||||||||||||||||||||||||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | uri | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||||||||||||||||||||||||||
| 130. Patient.communication.extension:comment.value[x] | |||||||||||||||||||||||||||||
| Definition | A comment on the linguistic proficiency. When using sign language, this field can be used to clarify, for example, which sign language is used. This can be informative, as there is not always a one-to-one relationship between the spoken language and sign language. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||||||||||||||||||||||||
| Short | CommentValue of extension | ||||||||||||||||||||||||||||
| Control | 0..1 | ||||||||||||||||||||||||||||
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||||||||||||||||||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Alternate Names | Toelichting | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 132. Patient.communication.modifierExtension | |||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 134. Patient.communication.language | |||||||||||||||||||||||||||||
| Definition | The language of communication. The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||||||||||||||||||||||||||
| Short | CommunicationLanguageThe language which can be used to communicate with the patient about his or her health | ||||||||||||||||||||||||||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from The codes SHOULD be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000http://hl7.org/fhir/ValueSet/languages CommunicatieTaalCodelijst A human language. | ||||||||||||||||||||||||||||
| Type | CodeableConcept | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | false | ||||||||||||||||||||||||||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||||||||||||||||||||||||||
| Alternate Names | CommunicatieTaal | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 136. Patient.link | |||||||||||||||||||||||||||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||||||||||||||||||||||||||
| Short | Link to another patient resource that concerns the same actual person | ||||||||||||||||||||||||||||
| Comments | There is no assumption that linked patient records have mutual links. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | BackboneElement | ||||||||||||||||||||||||||||
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | There are multiple use cases:
| ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 138. Patient.link.modifierExtension | |||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
| Control | 0..* | ||||||||||||||||||||||||||||
| Type | Extension | ||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||||||||||||||||||||||
| 140. Patient.link.other | |||||||||||||||||||||||||||||
| Definition | The other patient resource that the link refers to. | ||||||||||||||||||||||||||||
| Short | The other patient or related person resource that the link refers to | ||||||||||||||||||||||||||||
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Type | Reference(Patient, RelatedPerson) | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
| 142. Patient.link.type | |||||||||||||||||||||||||||||
| Definition | The type of link between this patient resource and another patient resource. | ||||||||||||||||||||||||||||
| Short | replaced-by | replaces | refer | seealso | ||||||||||||||||||||||||||||
| Control | 1..1 | ||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 The type of link between this patient resource and another patient resource. | ||||||||||||||||||||||||||||
| Type | code | ||||||||||||||||||||||||||||
| Is Modifier | false | ||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||||||||||||||||||||||
| Summary | true | ||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||||||||||||||||||||||
Guidance on how to interpret the contents of this table can be found here
| 0. Patient | |||||
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||||
| Short | Patient | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | SubjectOfCare Client Resident, Patient | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | ||||
| 2. Patient.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. Patient.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Patient.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. Patient.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages: A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. Patient.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. Patient.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Patient.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 16. Patient.extension:nationality | |||||
| Slice Name | nationality | ||||
| Definition | The nationality of the patient. | ||||
| Short | Nationality | ||||
| Comments | Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the zib cardinality of 0..1. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(nationality) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Patient.extension:nationality.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 20. Patient.extension:nationality.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 22. Patient.extension:nationality.extension:code | |||||
| Slice Name | code | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. Patient.extension:nationality.extension:code.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 26. Patient.extension:nationality.extension:code.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 28. Patient.extension:nationality.extension:code.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | code | ||||
| 30. Patient.extension:nationality.extension:code.value[x] | |||||
| Definition | Indicates the country of citizenship. | ||||
| Short | Nationality | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000 | ||||
| Type | CodeableConcept | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Nationaliteit | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. Patient.extension:nationality.extension:period | |||||
| Slice Name | period | ||||
| Definition | Period when nationality was effective. | ||||
| Short | Nationality Period | ||||
| Control | 0..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 34. Patient.extension:nationality.extension:period.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 36. Patient.extension:nationality.extension:period.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 38. Patient.extension:nationality.extension:period.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | period | ||||
| 40. Patient.extension:nationality.extension:period.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 | ||||
| Type | Period | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. Patient.extension:nationality.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-nationality | ||||
| 44. Patient.extension:nationality.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 0..0 | ||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. Patient.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 48. Patient.identifier | |||||
| Definition | The patient’s identification number. In transfer situations, use of the social security number (BSN) must comply with the Use of Social Security Numbers in Healthcare Act (Wbsn-z). In other situations, other number systems can be used, such as internal hospital patient numbers for example. | ||||
| Short | PatientIdentificationNumber | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Alternate Names | Identificatienummer | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 50. Patient.identifier:bsn | |||||
| Slice Name | bsn | ||||
| Definition | An identifier for this patient. | ||||
| Short | An identifier for this patient | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||||
| Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"><br/> <system value="http://fhir.nl/fhir/NamingSystem/bsn"/><br/></valueIdentifier><br/> | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. Patient.active | |||||
| Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. | ||||
| Short | Whether this patient's record is in active use | ||||
| Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to mark a patient record as not to be used because it was created in error. | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. Patient.name | |||||
| Definition | Patient's full name. | ||||
| Short | NameInformation / PayerName | ||||
| Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. | ||||
| Control | 0..* | ||||
| Type | HumanName | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Alternate Names | Naamgegevens, BetalerNaam | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.name. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 56. Patient.name:nameInformation | |||||
| Slice Name | nameInformation | ||||
| Definition | This slice represents the person's official name information, including given names, last name and possibly the partner's last name. | ||||
| Short | NameInformation | ||||
| Comments | This | ||||
| Control | 0..2 This element is affected by the following invariants: ele-1 | ||||
| Type | HumanName(zib NameInformation) | ||||
| Is Modifier | false | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Alternate Names | Naamgegevens | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))zib-NameInformation-1: 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: 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()) | ||||
| 58. Patient.name:nameInformation-GivenName | |||||
| Slice Name | nameInformation-GivenName | ||||
| Definition | This slice represents the name information normally used to address the person. | ||||
| Short | Name of a human - parts and usage | ||||
| Comments | This | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | HumanName(zib NameInformation.GivenName) | ||||
| Is Modifier | false | ||||
| Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. Patient.telecom | |||||
| Definition | Patient’s telephone number(s) or e-mail address(es). | ||||
| Short | ContactInformation | ||||
| Comments | The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | Contactgegevens | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.telecom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 62. Patient.telecom:telephoneNumbers | |||||
| Slice Name | telephoneNumbers | ||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||
| Short | TelephoneNumbers | ||||
| Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | ContactPoint(zib ContactInformation TelephoneNumbers) | ||||
| Is Modifier | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | Telefoonnummers | ||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||
| 64. Patient.telecom:emailAddresses | |||||
| Slice Name | emailAddresses | ||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||
| Short | EmailAddresses | ||||
| Comments | Implementation of the "EmailAddresses" concept of zib ContactInformation. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | ContactPoint(zib ContactInformation EmailAddresses) | ||||
| Is Modifier | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | EmailAdressen | ||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||
| 66. Patient.gender | |||||
| Definition | Patient’s administrative gender. | ||||
| Short | Gender | ||||
| Comments | The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender: Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. | ||||
| Alternate Names | Geslacht | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. Patient.gender.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 70. Patient.gender.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.gender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 72. Patient.gender.extension:genderCodelist | |||||
| Slice Name | genderCodelist | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Short | Optional Extensions Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ext CodeSpecification) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 74. Patient.gender.extension:genderCodelist.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 76. Patient.gender.extension:genderCodelist.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.gender.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 78. Patient.gender.extension:genderCodelist.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | ||||
| 80. Patient.gender.extension:genderCodelist.value[x] | |||||
| Definition | Patient’s administrative gender. | ||||
| Short | Gender | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000: GeslachtCodelijst | ||||
| Type | CodeableConcept | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Geslacht | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. Patient.gender.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 84. Patient.birthDate | |||||
| Definition | Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted. | ||||
| Short | DateOfBirth | ||||
| Comments | At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Age of the individual drives many clinical processes. | ||||
| Alternate Names | Geboortedatum | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| LOINC Code | 21112-8 | ||||
| 86. Patient.deceased[x] | |||||
| Definition | Indicates if the individual is deceased or not. | ||||
| Short | Indicates if the individual is deceased or not | ||||
| Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. | ||||
| Control | 0..1 | ||||
| Type | Choice of: boolean, dateTime | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.deceased[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 88. Patient.deceased[x]:deceasedBoolean | |||||
| Slice Name | deceasedBoolean | ||||
| Definition | An indication stating whether the patient has died. | ||||
| Short | DeathIndicator | ||||
| Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||
| Alternate Names | OverlijdensIndicator | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. Patient.deceased[x]:deceasedDateTime | |||||
| Slice Name | deceasedDateTime | ||||
| Definition | The date on which the patient died. A ‘vague’ date, such as only the year, is permitted. | ||||
| Short | DateOfDeath | ||||
| Comments | The zib recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | true because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. | ||||
| Alternate Names | DatumOverlijden, OverlijdensIndicator | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. Patient.address | |||||
| Definition | Patient's address information. | ||||
| Short | AddressInformation | ||||
| Comments | This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the zib AddressInformation v1.1 (2020). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Address(zib AddressInformation) | ||||
| Is Modifier | false | ||||
| Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. | ||||
| Alternate Names | Adresgegevens | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. Patient.maritalStatus | |||||
| Definition | A person’s marital status according to the terms and definition in the Dutch civil code. | ||||
| Short | MaritalStatus | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000: BurgerlijkeStaatCodelijst | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Most, if not all systems capture it. | ||||
| Alternate Names | BurgerlijkeStaat | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. Patient.multipleBirth[x] | |||||
| Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||||
| Short | Whether patient is part of a multiple birth | ||||
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). | ||||
| Control | 0..1 | ||||
| Type | Choice of: boolean, integer | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.multipleBirth[x]. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 98. Patient.multipleBirth[x]:multipleBirthBoolean | |||||
| Slice Name | multipleBirthBoolean | ||||
| Definition | An indication stating whether the patient is of a multiple birth. | ||||
| Short | MultipleBirthIndicator | ||||
| Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. | ||||
| Alternate Names | MeerlingIndicator | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. Patient.photo | |||||
| Definition | Image of the patient. | ||||
| Short | Image of the patient | ||||
| Comments | Guidelines: | ||||
| Control | 0..* | ||||
| Type | Attachment | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 102. Patient.contact | |||||
| Definition | A contact party (e.g. guardian, partner, friend) for the patient. | ||||
| Short | Contact | ||||
| Comments | Whereas the zib ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Need to track people you can contact about the patient. | ||||
| Alternate Names | Contactpersoon | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))pat-1: 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()) | ||||
| 104. Patient.contact.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 106. Patient.contact.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.contact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 108. Patient.contact.extension:contactPerson | |||||
| Slice Name | contactPerson | ||||
| Definition | In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. | ||||
| Short | This contact may have further details in this RelatedPerson | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(relatedPerson) (Extension Type: Reference(RelatedPerson)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 110. Patient.contact.extension:contactPerson.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 112. Patient.contact.extension:contactPerson.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.contact.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 114. Patient.contact.extension:contactPerson.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-relatedPerson | ||||
| 116. Patient.contact.extension:contactPerson.value[x] | |||||
| Definition | Reference to a zib-ContactPerson instance containing the full details for the current contact. | ||||
| Short | Contact | ||||
| Control | 1..1 | ||||
| Type | Reference(RelatedPerson, zib ContactPerson) | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Contactpersoon | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 118. Patient.contact.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 120. Patient.contact.relationship | |||||
| Definition | The nature of the relationship between the patient and the contact person. | ||||
| Short | The kind of relationship | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from PatientContactRelationship: The nature of the relationship between a patient and a contact person for that patient. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.contact.relationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 122. Patient.contact.relationship:role | |||||
| Slice Name | role | ||||
| Definition | Defines the role of the contact in relation to the patient. | ||||
| Short | Role | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000: RolCodelijst | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||
| Alternate Names | Rol | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. Patient.contact.relationship:relationship | |||||
| Slice Name | relationship | ||||
| Definition | Defines the contact’s familial relationship to the patient. | ||||
| Short | Relationship | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000: RelatieCodelijst | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. | ||||
| Alternate Names | Relatie | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. Patient.contact.name | |||||
| Definition | Full name of the contact. | ||||
| Short | NameInformation | ||||
| Comments | This element can and should not completely capture the NameInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full name information should instead be captured using an instance of zib-ContactPerson, which can then be referenced from this resource. See the comment on | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | HumanName(zib NameInformation) | ||||
| Is Modifier | false | ||||
| Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. | ||||
| Alternate Names | Naamgegevens | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))zib-NameInformation-1: 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: 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()) | ||||
| 128. Patient.contact.telecom | |||||
| Definition | The contact’s telephone number and/or e-mail address. | ||||
| Short | ContactInformation | ||||
| Comments | The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..*) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | Contactgegevens | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on Patient.contact.telecom. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 130. Patient.contact.telecom:telephoneNumbers | |||||
| Slice Name | telephoneNumbers | ||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||
| Short | TelephoneNumbers | ||||
| Comments | Implementation of the "TelephoneNumbers" concept of zib ContactInformation. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | ContactPoint(zib ContactInformation TelephoneNumbers) | ||||
| Is Modifier | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | Telefoonnummers | ||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||
| 132. Patient.contact.telecom:emailAddresses | |||||
| Slice Name | emailAddresses | ||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||
| Short | EmailAddresses | ||||
| Comments | Implementation of the "EmailAddresses" concept of zib ContactInformation. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | ContactPoint(zib ContactInformation EmailAddresses) | ||||
| Is Modifier | false | ||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
| Alternate Names | EmailAdressen | ||||
| Invariants | cpt-2: A system is required if a value is provided. (value.empty() or system.exists())ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count())) | ||||
| 134. Patient.contact.address | |||||
| Definition | Contact’s address information. | ||||
| Short | AddressInformation | ||||
| Comments | This element can and should not completely capture the AddressInformation concept from zib ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of zib-ContactPerson, which can then be referenced from this resource. See the comment on | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Address(zib AddressInformation) | ||||
| Is Modifier | false | ||||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||||
| Alternate Names | Adresgegevens | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 136. Patient.contact.gender | |||||
| Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. | ||||
| Short | male | female | other | unknown | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdministrativeGender: The gender of a person used for administrative purposes. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | Needed to address the person correctly. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 138. Patient.contact.organization | |||||
| Definition | Organization on behalf of which the contact is acting or for which the contact is working. | ||||
| Short | Organization that is associated with the contact | ||||
| Control | 0..1 This element is affected by the following invariants: pat-1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | For guardians or business related contacts, the organization is relevant. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 140. Patient.contact.period | |||||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 142. Patient.communication | |||||
| Definition | A language which may be used to communicate with the patient about his or her health. | ||||
| Short | LanguageProficiency | ||||
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. | ||||
| Alternate Names | Taalvaardigheid | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 144. Patient.communication.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 146. Patient.communication.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.communication.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 148. Patient.communication.extension:languageControl | |||||
| Slice Name | languageControl | ||||
| Definition | The ability to understand spoken text in the language in question. The ability to express oneself in spoken language. The ability to understand written text in he language in question. | ||||
| Short | LanguageControlListening / LanguageControlSpeaking / LanguageControlReading | ||||
| Comments | The zib concepts LanguageControlListening, LanguageControlReading, LanguageControlSpeaking are captured using a core extension from the R4 FHIR specification. Each of these three concepts is encoded as a copy of the extension, typed using the code in the type slice according to the following mapping: | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(proficiency) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Alternate Names | TaalvaardigheidBegrijpen, TaalvaardigheidSpreken, TaalvaardigheidLezen | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 150. Patient.communication.extension:languageControl.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 152. Patient.communication.extension:languageControl.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 2..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.communication.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 154. Patient.communication.extension:languageControl.extension:level | |||||
| Slice Name | level | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 156. Patient.communication.extension:languageControl.extension:level.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 158. Patient.communication.extension:languageControl.extension:level.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.communication.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 160. Patient.communication.extension:languageControl.extension:level.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | level | ||||
| 162. Patient.communication.extension:languageControl.extension:level.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Comments | The zib ValueSets TaalvaardigheidBegrijpenCodelijst, TaalvaardigheidSprekenCodelijst and TaalvaardigheidLezenCodelijst are equal to the default FHIR ValueSet. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from LanguageAbilityProficiency | ||||
| Type | Coding | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 164. Patient.communication.extension:languageControl.extension:type | |||||
| Slice Name | type | ||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 166. Patient.communication.extension:languageControl.extension:type.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 168. Patient.communication.extension:languageControl.extension:type.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.communication.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 170. Patient.communication.extension:languageControl.extension:type.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | type | ||||
| 172. Patient.communication.extension:languageControl.extension:type.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 1..1 | ||||
| Binding | The codes SHOULD be taken from LanguageAbilityMode: The proficiency type for the communication. | ||||
| Type | Coding | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 174. Patient.communication.extension:languageControl.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-proficiency | ||||
| 176. Patient.communication.extension:languageControl.value[x] | |||||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
| Short | Value of extension | ||||
| Control | 0..0 | ||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 178. Patient.communication.extension:communicationDetails | |||||
| Slice Name | communicationDetails | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Short | Optional Extensions Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ext LanguageProficiency.CommunicationDetails) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 180. Patient.communication.extension:comment | |||||
| Slice Name | comment | ||||
| Definition | Optional Extension Element - found in all resources. | ||||
| Short | Optional Extensions Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(ext Comment) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 182. Patient.communication.extension:comment.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 184. Patient.communication.extension:comment.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Patient.communication.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: | ||||
| 186. Patient.communication.extension:comment.url | |||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
| Short | identifies the meaning of the extension | ||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| Fixed Value | http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||
| 188. Patient.communication.extension:comment.value[x] | |||||
| Definition | A comment on the linguistic proficiency. When using sign language, this field can be used to clarify, for example, which sign language is used. This can be informative, as there is not always a one-to-one relationship between the spoken language and sign language. | ||||
| Short | Comment | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Alternate Names | Toelichting | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 190. Patient.communication.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 192. Patient.communication.language | |||||
| Definition | The language of communication. | ||||
| Short | CommunicationLanguage | ||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000: CommunicatieTaalCodelijst | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||
| Alternate Names | CommunicatieTaal | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 194. Patient.communication.preferred | |||||
| Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||||
| Short | Language preference indicator | ||||
| Comments | This language is specifically identified for communicating healthcare information. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 196. Patient.generalPractitioner | |||||
| Definition | Patient's nominated care provider. | ||||
| Short | Patient's nominated primary care provider | ||||
| Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. | ||||
| Control | 0..* | ||||
| Type | Reference(Organization, Practitioner, PractitionerRole) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | careProvider | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 198. Patient.managingOrganization | |||||
| Definition | Organization that is the custodian of the patient record. | ||||
| Short | Organization that is the custodian of the patient record | ||||
| Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Need to know who recognizes this patient record, manages and updates it. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 200. Patient.link | |||||
| Definition | Link to another patient resource that concerns the same actual patient. | ||||
| Short | Link to another patient resource that concerns the same actual person | ||||
| Comments | There is no assumption that linked patient records have mutual links. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | true because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by' | ||||
| Summary | true | ||||
| Requirements | There are multiple use cases: | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 202. Patient.link.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 204. Patient.link.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 206. Patient.link.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 208. Patient.link.other | |||||
| Definition | The other patient resource that the link refers to. | ||||
| Short | The other patient or related person resource that the link refers to | ||||
| Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. | ||||
| Control | 1..1 | ||||
| Type | Reference(Patient, RelatedPerson) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 210. Patient.link.type | |||||
| Definition | The type of link between this patient resource and another patient resource. | ||||
| Short | replaced-by | replaces | refer | seealso | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from LinkType: The type of link between this patient resource and another patient resource. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||