ZD Patient
Resources conforming to this profile are requested by ZorgDomein when SSO has succeeded and patient details are fetched from the source system. Patient resources are requested by FHIR read request (i.e. a direct call on the patient id like https://[FHIRServerUrl]/Patient/[PatientID]).
Resources conforming to the ZD Patient profile are sent by ZorgDomein as part of a Bundle that is sent to deliver a FHIR document to the information system of the referrer or care provider.
The canonical URL for this profile is:
http://zorgdomein.nl/fhir/StructureDefinition/zd-patient
This profile builds on Patient.
| Patient | S | 0..* | Patient | Element Id
Patient Information about an individual receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
|
| extension | 0..* | Extension | Element Id
Patient.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| pharmacy | 0..1 | Extension(Reference(nl-core-organization)) | Element Id
Patient.extension:pharmacy Reference to patient's primary pharmacy Alternate namesextensions, user content DefinitionReference to patient's primary pharmacy 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. Extension(Reference(nl-core-organization)) Extension URLhttp://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.extension:pharmacy.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy
|
|
| valueReference | 1..1 | Reference(nl-core-organization) |
There are no (further) constraints on this element Element Id
Patient.extension:pharmacy.valueReference:valueReference Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded Reference(nl-core-organization) Constraints
|
|
| identifier | Σ | 0..* | Identifier | Element Id
Patient.identifier An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open, by system(Value) Constraints
|
| BSN | S Σ | 0..1 | Identifier | Element Id
Patient.identifier:BSN BSN DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
|
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element Id
Patient.identifier:BSN.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
official
|
| type | Σ | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Patient.identifier:BSN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element Id
Patient.identifier:BSN.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://fhir.nl/fhir/NamingSystem/bsn
|
| value | Σ | 1..1 | string | Element Id
Patient.identifier:BSN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General
123456 General
447363669 Mappings
|
| period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Patient.identifier:BSN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
| assigner | Σ | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
Patient.identifier:BSN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| active | Σ ?! | 0..1 | boolean |
There are no (further) constraints on this element Element Id
Patient.active Whether this patient's record is in active use DefinitionWhether this patient record is in active use. Need to be able to mark a patient record as not to be used because it was created in error. Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.
true
|
| name | S Σ | 0..* | nl-core-humanname | Element Id
Patient.name Name of a human - parts and usage Alternate namesNaamgegevens DefinitionA human's name with the ability to identify parts and usage. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. A Dutch HumanName is a proper FHIR HumanName. Systems that do not understand any of the extensions, will be able to render and work with a Dutch name. Dutch names make certain name parts seaprately communicable. These parts are required for use in true Dutch systems when dealing with Dutch names, but may not have value for international systems when information gets sent abroad. To have true compatibility an implementer SHOULD use the core HumanName parts as intended. To have names work for Dutch context, the implementer SHOULD in addition use the extension elements. The extension elements cover birth name (NL: eigennaam / geslachtsnaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is. Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas family = "Jongeneel-de Haas" given = "Irma" humanname-own-name = "Jongeneel" humanname-partner-prefix = "de " humanname-partner-name = "Haas"
Structured HumanName (preferred above unstructured)
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"valueCode": "NL4"
}
],
"use": "official",
"family": "Jongeneel-de Haas",
"_family": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"valueString": "Jongeneel"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
"valueString": "de"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
"valueString": "Haas"
}
]
},
"given": [
"Irma",
"I."
],
"_given": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "CL"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "IN"
}
]
}
]
}
Unstructured HumanName
{
"use": "official",
"text": "Irma Jongeneel-de Haas"
}
Mappings
|
| telecom | S Σ | 0..* | ContactPoint |
There are no (further) constraints on this element Element Id
Patient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. 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 may 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).
|
| system | Σ | 1..1 | codeBinding |
There are no (further) constraints on this element Element Id
Patient.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings may not exceed 1MB in size
|
| value | Σ | 1..1 | string |
There are no (further) constraints on this element Element Id
Patient.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
| use | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Patient.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
|
| rank | Σ | 0..1 | positiveInt |
There are no (further) constraints on this element Element Id
Patient.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
| period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Patient.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
| gender | S Σ | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Patient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes. The gender may 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 M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, 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, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error. AdministrativeGender (required) Constraints
|
| birthDate | S Σ | 0..1 | date | Element Id
Patient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. 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 maternaty/infant care systems).
|
| deceased[x] | Σ ?! | 0..1 |
There are no (further) constraints on this element Element Id
Patient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. 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. 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. 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.
|
|
| deceasedBoolean | boolean |
There are no (further) constraints on this element Data Type
|
||
| deceasedDateTime | dateTime |
There are no (further) constraints on this element Data Type
|
||
| address | S Σ | 0..* | nl-core-address | Element Id
Patient.address Addresses for the individual Alternate namesAdresInformatie DefinitionThis datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). 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 HCIM 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 HCIM 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 HCIM code itself should also be included using the AddressType extension. If Address.type is "both" then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses. 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 HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Note: address is for postal addresses, not physical locations.
Example of a Vacation Home address
{
"extension": [
{
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/AddressUse",
"code": "HV",
"display": "Vakantie adres"
}
]
}
}
],
"use": "temp",
"line": [
"Binnenkant 12A Hoog"
],
"_line": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString": "Binnenkant"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString": "12"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix",
"valueString": "A"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID",
"valueString": "Hoog"
}
]
}
],
"city": "Amsterdam",
"state": "NH",
"postalCode": "1000AA",
"country": "NLD"
}
Example of a Primary Home address
{
"extension": [
{
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/AddressUse",
"code": "HP",
"display": "Officieel adres"
}
]
}
},
{
"url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean": true
}
],
"use": "home",
"line": [
"Binnenkant to 10"
],
"_line": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString": "Binnenkant"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator",
"valueString": "to"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString": "10"
}
]
}
],
"city": "Amsterdam",
"state": "NH",
"postalCode": "1001AA",
"country": "NLD"
}
Mappings
|
| extension | 0..* | Extension |
There are no (further) constraints on this element Element Id
Patient.address.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| AddressType | 0..1 | Extension(CodeableConcept) |
There are no (further) constraints on this element Element Id
Patient.address.extension:AddressType Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.extension:AddressType.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType
|
|
| valueCodeableConcept | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Patient.address.extension:AddressType.value[x]:valueCodeableConcept AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. This extension can be used to include the HCIM AddressType code. See the documentation on the root level for mapping these codes to the various elements of this datatype. 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 HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension. AdresSoortCodelijst (extensible) Constraints
|
|
| official | 0..1 | Extension(boolean) |
There are no (further) constraints on this element Element Id
Patient.address.extension:official Mark an address as an 'officially registered' address. Alternate namesextensions, user content, Markeer een adres als een 'officieel geregistreerd adres. DefinitionMark an address as an 'officially registered' address. In Dutch context that means it is registered in the Basisregistratie persoonsgegevens (BRP) 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. http://fhir.nl/fhir/StructureDefinition/nl-core-address-official Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.extension:official.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://fhir.nl/fhir/StructureDefinition/nl-core-address-official
|
|
| valueBoolean | 1..1 | boolean |
There are no (further) constraints on this element Element Id
Patient.address.extension:official.valueBoolean:valueBoolean true if part of an official registry. false if it is not Alternate namestrue als deze deel is van een officieel register. false indien dat niet het geval is DefinitionWhen the value is true, this address is marked to be part of an official registry (Dutch realm: BRP). When the value is false, this address is explicitly marked as not part of an official registry. A stream of bytes, base64 encoded
|
|
| use | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Patient.address.use home | work | temp | old - purpose of this address DefinitionPurpose of this address Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. Permitted Values AdresSoortCodelijst-to-AddressUse Constraints
General
home Mappings
|
| type | Σ | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Patient.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Note that FHIR strings may not exceed 1MB in size Permitted Values AdresSoortCodelijst-to-AddressType Constraints
General
both Mappings
|
| text | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.text Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts.
General
137 Nowhere Street, Erewhon 9132 Mappings
|
| line | Σ | 0..* | string |
There are no (further) constraints on this element Element Id
Patient.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. Note that FHIR strings may not exceed 1MB in size
General
137 Nowhere Street Mappings
|
| extension | 0..* | Extension |
There are no (further) constraints on this element Element Id
Patient.address.line.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| streetName | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:streetName streetName Alternate namesextensions, user content DefinitionStreet name. If the address is a P.O. Box then the Dutch word "Postbus" shall be communicated. If the address is an answer number (mailing address where the receiver pays postage) then the Dutch word "Antwoordnummer" shall be communicated. Basisregistratie Persoonsgegevens 11.10 Straatnaam 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:streetName.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
|
|
| valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:streetName.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| houseNumber | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:houseNumber houseNumber Alternate namesextensions, user content DefinitionThe element houseNumber shall contain the house number. The house number may contains non-numeric parts that further determine the address, e.g. "23a", but only if the source system cannot discretely communicate those. House letter shall, if possible, be communicated through the element buildingNumberSuffix. Information such as "to" (house boats that do not have their own house number, but are across (tegenover) a house with a house number or "3 hoog achter" are not part of this attribute. This type of information is conveyed elsewhere in the Address datatype. Basisregistratie Persoonsgegevens 11.20 Huisnummer 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:houseNumber.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
|
|
| valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:houseNumber.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| buildingNumbersuffix | 0..* | Extension(string) |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:buildingNumbersuffix buildingNumberSuffix Alternate namesextensions, user content DefinitionHouseNumberLetter
HouseNumberAddition
Basisregistratie Persoonsgegevens 11.30 Huisletter 11.40 Huisnummertoevoeging 12.10 Locatieomschrijving Export
Import
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:buildingNumbersuffix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
|
|
| valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:buildingNumbersuffix.value[x]:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| unitID | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:unitID unitID Alternate namesextensions, user content DefinitionExtra information such as the building name, building number, entrance, route number. 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:unitID.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
|
|
| valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:unitID.value[x]:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| additionalLocator | 0..1 | Extension(string) |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:additionalLocator additionalLocator Alternate namesextensions, user content DefinitionHouseNumberIndication - The indication used for addresses that do not consist of the usual street name and house number. Basisregistratie Persoonsgegevens 11.50 Aanduiding bij huisnummer 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. http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:additionalLocator.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
|
|
| valueString | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:additionalLocator.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| buildingNumberSuffix | 0..* | Extension |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:buildingNumberSuffix Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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.
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:buildingNumberSuffix.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
buildingNumberSuffix
|
|
| valueString | 0..1 |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:buildingNumberSuffix.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
||
| valueBase64Binary | base64Binary |
There are no (further) constraints on this element Data Type
|
||
| valueBoolean | boolean |
There are no (further) constraints on this element Data Type
|
||
| valueCode | code |
There are no (further) constraints on this element Data Type
|
||
| valueDate | date |
There are no (further) constraints on this element Data Type
|
||
| valueDateTime | dateTime |
There are no (further) constraints on this element Data Type
|
||
| valueDecimal | decimal |
There are no (further) constraints on this element Data Type
|
||
| valueId | id |
There are no (further) constraints on this element Data Type
|
||
| valueInstant | instant |
There are no (further) constraints on this element Data Type
|
||
| valueInteger | integer |
There are no (further) constraints on this element Data Type
|
||
| valueMarkdown | markdown |
There are no (further) constraints on this element Data Type
|
||
| valueOid | oid |
There are no (further) constraints on this element Data Type
|
||
| valuePositiveInt | positiveInt |
There are no (further) constraints on this element Data Type
|
||
| valueString | string |
There are no (further) constraints on this element Data Type
|
||
| valueTime | time |
There are no (further) constraints on this element Data Type
|
||
| valueUnsignedInt | unsignedInt |
There are no (further) constraints on this element Data Type
|
||
| valueUri | uri |
There are no (further) constraints on this element Data Type
|
||
| valueAddress | Address |
There are no (further) constraints on this element Data Type
|
||
| valueAge | Age |
There are no (further) constraints on this element Data Type
|
||
| valueAnnotation | Annotation |
There are no (further) constraints on this element Data Type
|
||
| valueAttachment | Attachment |
There are no (further) constraints on this element Data Type
|
||
| valueCodeableConcept | CodeableConcept |
There are no (further) constraints on this element Data Type
|
||
| valueCoding | Coding |
There are no (further) constraints on this element Data Type
|
||
| valueContactPoint | ContactPoint |
There are no (further) constraints on this element Data Type
|
||
| valueCount | Count |
There are no (further) constraints on this element Data Type
|
||
| valueDistance | Distance |
There are no (further) constraints on this element Data Type
|
||
| valueDuration | Duration |
There are no (further) constraints on this element Data Type
|
||
| valueHumanName | HumanName |
There are no (further) constraints on this element Data Type
|
||
| valueIdentifier | Identifier |
There are no (further) constraints on this element Data Type
|
||
| valueMoney | Money |
There are no (further) constraints on this element Data Type
|
||
| valuePeriod | Period |
There are no (further) constraints on this element Data Type
|
||
| valueQuantity | Quantity |
There are no (further) constraints on this element Data Type
|
||
| valueRange | Range |
There are no (further) constraints on this element Data Type
|
||
| valueRatio | Ratio |
There are no (further) constraints on this element Data Type
|
||
| valueSampledData | SampledData |
There are no (further) constraints on this element Data Type
|
||
| valueSignature | Signature |
There are no (further) constraints on this element Data Type
|
||
| valueTiming | Timing |
There are no (further) constraints on this element Data Type
|
||
| valueMeta | Meta |
There are no (further) constraints on this element Data Type
|
||
| valueReference | Reference() |
There are no (further) constraints on this element Data Type
|
||
| unitID | 0..* | Extension |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:unitID Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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.
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:unitID.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
unitID
|
|
| valueString | 0..1 |
There are no (further) constraints on this element Element Id
Patient.address.line.extension:unitID.valueString:valueString Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
||
| valueBase64Binary | base64Binary |
There are no (further) constraints on this element Data Type
|
||
| valueBoolean | boolean |
There are no (further) constraints on this element Data Type
|
||
| valueCode | code |
There are no (further) constraints on this element Data Type
|
||
| valueDate | date |
There are no (further) constraints on this element Data Type
|
||
| valueDateTime | dateTime |
There are no (further) constraints on this element Data Type
|
||
| valueDecimal | decimal |
There are no (further) constraints on this element Data Type
|
||
| valueId | id |
There are no (further) constraints on this element Data Type
|
||
| valueInstant | instant |
There are no (further) constraints on this element Data Type
|
||
| valueInteger | integer |
There are no (further) constraints on this element Data Type
|
||
| valueMarkdown | markdown |
There are no (further) constraints on this element Data Type
|
||
| valueOid | oid |
There are no (further) constraints on this element Data Type
|
||
| valuePositiveInt | positiveInt |
There are no (further) constraints on this element Data Type
|
||
| valueString | string |
There are no (further) constraints on this element Data Type
|
||
| valueTime | time |
There are no (further) constraints on this element Data Type
|
||
| valueUnsignedInt | unsignedInt |
There are no (further) constraints on this element Data Type
|
||
| valueUri | uri |
There are no (further) constraints on this element Data Type
|
||
| valueAddress | Address |
There are no (further) constraints on this element Data Type
|
||
| valueAge | Age |
There are no (further) constraints on this element Data Type
|
||
| valueAnnotation | Annotation |
There are no (further) constraints on this element Data Type
|
||
| valueAttachment | Attachment |
There are no (further) constraints on this element Data Type
|
||
| valueCodeableConcept | CodeableConcept |
There are no (further) constraints on this element Data Type
|
||
| valueCoding | Coding |
There are no (further) constraints on this element Data Type
|
||
| valueContactPoint | ContactPoint |
There are no (further) constraints on this element Data Type
|
||
| valueCount | Count |
There are no (further) constraints on this element Data Type
|
||
| valueDistance | Distance |
There are no (further) constraints on this element Data Type
|
||
| valueDuration | Duration |
There are no (further) constraints on this element Data Type
|
||
| valueHumanName | HumanName |
There are no (further) constraints on this element Data Type
|
||
| valueIdentifier | Identifier |
There are no (further) constraints on this element Data Type
|
||
| valueMoney | Money |
There are no (further) constraints on this element Data Type
|
||
| valuePeriod | Period |
There are no (further) constraints on this element Data Type
|
||
| valueQuantity | Quantity |
There are no (further) constraints on this element Data Type
|
||
| valueRange | Range |
There are no (further) constraints on this element Data Type
|
||
| valueRatio | Ratio |
There are no (further) constraints on this element Data Type
|
||
| valueSampledData | SampledData |
There are no (further) constraints on this element Data Type
|
||
| valueSignature | Signature |
There are no (further) constraints on this element Data Type
|
||
| valueTiming | Timing |
There are no (further) constraints on this element Data Type
|
||
| valueMeta | Meta |
There are no (further) constraints on this element Data Type
|
||
| valueReference | Reference() |
There are no (further) constraints on this element Data Type
|
||
| city | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.city Name of city, town etc. Alternate namesMunicpality, Municipality, woonplaats DefinitionThe name of the city, town, village or other community or delivery center. Basisregistratie Persoonsgegevens 11.70 Woonplaatsnaam Note that FHIR strings may not exceed 1MB in size
General
Erewhon Example city
Den Haag Mappings
|
| district | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.district District name (aka county) Alternate namesCounty, Gemeente DefinitionThe name of the administrative area (county). Basisregistratie Persoonsgegevens 09.10 Gemeente van inschrijving District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. In a Dutch address this element is used for the population of a "gemeente"
General
Madison Example district
Wateringen Mappings
|
| state | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.state Sub-unit of country (abbreviations ok). Alternate namesProvince, Territory, Provincie DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). For Dutch addresses this element should contain the "provincie" code Some (Dutch) cities have the same name in multiple provinces. Dutch examples include Bergen (Noord-Holland / Limburg) and Geesteren (Gelderland / Overijssel). Note that FHIR strings may not exceed 1MB in size
Example province
ZH Mappings
|
| postalCode | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.postalCode Postal code for area Alternate namesZip, Postcode DefinitionA postal code designating a region defined by the postal service. Dutch postal codes have pattern '\d{4}[A-Z]{2}' so they do not have spaces. Systems can easily render postal codes with a space if necessary.
General
9132 Example postcode
9132AG Mappings
|
| country | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.country Country (can be ISO 3166 3 letter code) Alternate namesland DefinitionA country (code) for the address. The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the code-specification extension under Address.country.
Example country
NLD Mappings
|
| extension | 0..* | Extension |
There are no (further) constraints on this element Element Id
Patient.address.country.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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. 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. Unordered, Open, by url(Value) Constraints
|
|
| countryCode | 0..1 | Extension(CodeableConcept) |
There are no (further) constraints on this element Element Id
Patient.address.country.extension:countryCode CountryGBACode | CountryISOCode Alternate namesextensions, user content, Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet. DefinitionDefines a more specific coded value for a code or string. Especially useful for FHIR's required ValueSets. These extensions are primarily used on codes bound to a required value set, where you would like to use a more specific code than the codes in the bounded value set. 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. http://nictiz.nl/fhir/StructureDefinition/code-specification Constraints
|
|
| url | 1..1 | uriFixed Value |
There are no (further) constraints on this element Element Id
Patient.address.country.extension:countryCode.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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.
http://nictiz.nl/fhir/StructureDefinition/code-specification
|
|
| valueCodeableConcept | 1..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
Patient.address.country.extension:countryCode.value[x]:valueCodeableConcept CountryGBACode | CountryISOCode Alternate namesLandGBACodelijst, LandISOCodelijst DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A stream of bytes, base64 encoded
|
|
| coding | Σ | 1..* | Coding |
There are no (further) constraints on this element Element Id
Patient.address.country.extension:countryCode.value[x]:valueCodeableConcept.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
| countryGBACodelist | Σ | 0..* | CodingBinding |
There are no (further) constraints on this element Element Id
Patient.address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryGBACodelist Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.16.34"
}
|
| countryISOCodelist | Σ | 0..* | CodingBinding |
There are no (further) constraints on this element Element Id
Patient.address.country.extension:countryCode.value[x]:valueCodeableConcept.coding:countryISOCodelist Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{
"system": "urn:iso:std:iso:3166"
}
|
| text | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
Patient.address.country.extension:countryCode.value[x]:valueCodeableConcept.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
Patient.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
General
{
"start": "2010-03-23",
"end": "2010-07-01"
}
Mappings
|
| maritalStatus | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Patient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Marital Status Codes (extensible) Constraints
|
|
| multipleBirth[x] | 0..1 |
There are no (further) constraints on this element Element Id
Patient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).
|
||
| multipleBirthBoolean | boolean |
There are no (further) constraints on this element Data Type
|
||
| multipleBirthInteger | integer |
There are no (further) constraints on this element Data Type
|
||
| photo | 0..* | Attachment |
There are no (further) constraints on this element Element Id
Patient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment".
|
|
| contact | 0..* | BackboneElement |
There are no (further) constraints on this element Element Id
Patient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. 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.
|
|
| relationship | 0..* | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Patient.contact.relationship The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
|
|
| name | 0..1 | HumanName |
There are no (further) constraints on this element Element Id
Patient.contact.name A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
|
|
| telecom | 0..* | ContactPoint |
There are no (further) constraints on this element Element Id
Patient.contact.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
|
| address | 0..1 | Address |
There are no (further) constraints on this element Element Id
Patient.contact.address Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. Note: address is for postal addresses, not physical locations.
|
|
| gender | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
Patient.contact.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings may not exceed 1MB in size AdministrativeGender (required) Constraints
|
|
| organization | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
Patient.contact.organization Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
|
| period | 0..1 | Period |
There are no (further) constraints on this element Element Id
Patient.contact.period The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
|
| animal | Σ ?! | 0..0 | BackboneElement |
There are no (further) constraints on this element Element Id
Patient.animal This patient is known to be an animal (non-human) DefinitionThis patient is known to be an animal. Many clinical systems are extended to care for animal patients as well as human. The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
|
| communication | 0..* | BackboneElement |
There are no (further) constraints on this element Element Id
Patient.communication A list of Languages which may be used to communicate with the patient about his or her health DefinitionLanguages which may be used to communicate with the patient about his or her health. If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. 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.
|
|
| language | 1..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Patient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. 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.
|
|
| preferred | 0..1 | boolean |
There are no (further) constraints on this element Element Id
Patient.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). 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. This language is specifically identified for communicating healthcare information.
|
|
| generalPractitioner | 0..* | Reference(Organization | Practitioner) |
There are no (further) constraints on this element Element Id
Patient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity 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. Reference(Organization | Practitioner) Constraints
|
|
| managingOrganization | Σ | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
Patient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. 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).
|
| link | Σ ?! | 0..* | BackboneElement |
There are no (further) constraints on this element Element Id
Patient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple usecases:
There is no assumption that linked patient records have mutual links. This element is labelled as a modifier because it may 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'.
|
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) |
There are no (further) constraints on this element Element Id
Patient.link.other The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Constraints
|
| type | Σ | 1..1 | codeBinding |
There are no (further) constraints on this element Element Id
Patient.link.type replaced-by | replaces | refer | seealso - type of link DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings may not exceed 1MB in size
|
See the profile on simplifier.net for additional details.
Resource example
Below you find an example of a Patient resource that conforms to the ZD Patient profile.
{
"resourceType": "Patient",
"id": "zd-patient-1",
"meta": {
"profile": [
"http://zorgdomein.nl/fhir/StructureDefinition/zd-patient"
]
},
"identifier": [
{
"use": "official",
"system": "http://fhir.nl/fhir/NamingSystem/bsn",
"value": "695752947"
}
],
"name": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"valueCode": "NL4"
}
],
"use": "official",
"family": "Aelbrinck-de Jager",
"_family": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"valueString": "Aelbrinck"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
"valueString": "de"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
"valueString": "Jager"
}
]
},
"given": [
"Kristel",
"K."
],
"_given": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "CL"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "IN"
}
]
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "0650896532",
"use": "mobile"
},
{
"system": "email",
"value": "k.aelbrinck@home.nl",
"use": "home"
}
],
"gender": "female",
"birthDate": "1979-02-02",
"address": [
{
"extension": [
{
"url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
"valueBoolean": true
}
],
"type": "physical",
"line": [
"Zuiderhaven 1a 2hg"
],
"_line": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
"valueString": "Zuiderhaven"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString": "1"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix",
"valueString": "a"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator",
"valueString": "2hg"
}
]
}
],
"city": "Amsterdam",
"postalCode": "1060HT",
"country": "NL"
}
]
}
<Patient xmlns='http://hl7.org/fhir'>
<id value='zd-patient-1'/>
<meta>
<profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-patient'/>
</meta>
<identifier>
<use value='official'/>
<system value='http://fhir.nl/fhir/NamingSystem/bsn'/>
<value value='695752947'/>
</identifier>
<name>
<extension url='http://hl7.org/fhir/StructureDefinition/humanname-assembly-order'>
<valueCode value='NL4'/>
</extension>
<use value='official'/>
<family value='Aelbrinck-de Jager'>
<extension url='http://hl7.org/fhir/StructureDefinition/humanname-own-name'>
<valueString value='Aelbrinck'/>
</extension>
<extension url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix'>
<valueString value='de'/>
</extension>
<extension url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name'>
<valueString value='Jager'/>
</extension>
</family>
<given value='Kristel'>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier'>
<valueCode value='CL'/>
</extension>
</given>
<given value='K.'>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier'>
<valueCode value='IN'/>
</extension>
</given>
</name>
<telecom>
<system value='phone'/>
<value value='0650896532'/>
<use value='mobile'/>
</telecom>
<telecom>
<system value='email'/>
<value value='k.aelbrinck@home.nl'/>
<use value='home'/>
</telecom>
<gender value='female'/>
<birthDate value='1979-02-02'/>
<address>
<extension url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'>
<valueBoolean value='true'/>
</extension>
<type value='physical'/>
<line value='Zuiderhaven 1a 2hg'>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'>
<valueString value='Zuiderhaven'/>
</extension>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber'>
<valueString value='1'/>
</extension>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix'>
<valueString value='a'/>
</extension>
<extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator'>
<valueString value='2hg'/>
</extension>
</line>
<city value='Amsterdam'/>
<postalCode value='1060HT'/>
<country value='NL'/>
</address>
</Patient>