Patient
Patient | I | Patient | There are no (further) constraints on this element Element idPatient Patient Alternate namesSubjectOfCare Client Resident, Patient, nl-core-Patient DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |||||||||||||||||||||||||||||
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||||||||||||||||||||||||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Metadata about the resource DefinitionThe 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.
| ||||||||||||||||||||||||||||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
| ||||||||||||||||||||||||||||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||||||||||||||||||||||||||||
text | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |||||||||||||||||||||||||||||
contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
nationality | I | 0..0 | Extension(Complex) | Element idPatient.extension:nationality Nationality Alternate namesextensions, user content DefinitionThe nationality of the patient. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-nationality Constraints
| ||||||||||||||||||||||||||||
resource-origin | I | 0..1 | Extension(Reference(KT2_Device)) | Element idPatient.extension:resource-origin Optional Extensions Element Alternate namesextensions, user content DefinitionDefines the author of the resource. Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it. Extension(Reference(KT2_Device)) Extension URLhttp://koppeltaal.nl/fhir/StructureDefinition/resource-origin Constraints
| ||||||||||||||||||||||||||||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
identifier | Σ | 1..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open, by $this(Value) Constraints
| ||||||||||||||||||||||||||||
bsn | Σ | 0..* | IdentifierPattern | There are no (further) constraints on this element Element idPatient.identifier:bsn PatientIdentificationNumber Alternate namesIdentificatienummer DefinitionThe 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. Patients are almost always assigned specific numerical identifiers.
{ "system": "http://fhir.nl/fhir/NamingSystem/bsn" }
| ||||||||||||||||||||||||||||
active | Σ ?! | 1..1 | boolean | There are no (further) constraints on this element Element idPatient.active Whether this patient's record is in active use DefinitionWhether 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. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element
| ||||||||||||||||||||||||||||
name | Σ I | 1..* | HumanName | Element idPatient.name NameInformation / PayerName Alternate namesNaamgegevens, BetalerNaam DefinitionPatient's full name. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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. Unordered, Open, by use(Value) Constraints
| ||||||||||||||||||||||||||||
nameInformation | Σ I | 0..2 | nl core NameInformation | Element idPatient.name:nameInformation NameInformation Alternate namesNaamgegevens, nl-core-NameInformation DefinitionThis slice represents the person's official name information, including given names, last name and possibly the partner's last name. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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.
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
nameUsage | I | 0..1 | Extension(code) | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage Preferred display order of name parts Alternate namesextensions, user content DefinitionA code that represents the preferred display order of the components of this human name. 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/humanname-assembly-order Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.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/humanname-assembly-order
| |||||||||||||||||||||||||||||
value[x] | 1..1 | Binding | There are no (further) constraints on this element Element idPatient.name:nameInformation.extension:nameUsage.value[x] NameUsage Alternate namesNaamgebruik DefinitionThis concept indicates the last name or order of last names with which the person is to be addressed. Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder Permitted Values NaamgebruikCodelijst_to_HumanNameAssemblyOrder Constraints
| |||||||||||||||||||||||||||||
valueCode | code | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
use | Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
official
| ||||||||||||||||||||||||||||
text | Σ | 0..1 | string | Element idPatient.name:nameInformation.text Text representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
family | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
prefix | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix Voorvoegsel derived from person's own surname Alternate namesextensions, user content DefinitionThe prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. http://hl7.org/fhir/StructureDefinition/humanname-own-prefix Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix.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/humanname-own-prefix
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:prefix.value[x] Prefix Alternate namesVoorvoegsels DefinitionPrefix to the person’s own last name.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
lastName | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName Portion derived from person's own surname Alternate namesextensions, user content DefinitionThe portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". http://hl7.org/fhir/StructureDefinition/humanname-own-name Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName.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/humanname-own-name
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:lastName.value[x] LastName Alternate namesAchternaam DefinitionThe person’s official last name
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
partnerPrefix | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix Voorvoegsel derived from person's partner's surname Alternate namesextensions, user content DefinitionThe prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.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/humanname-partner-prefix
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerPrefix.value[x] PartnerPrefix Alternate namesVoorvoegselsPartner DefinitionPrefix to the partner’s last name.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
partnerLastName | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName Portion derived from person's partner's surname Alternate namesextensions, user content DefinitionThe portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". http://hl7.org/fhir/StructureDefinition/humanname-partner-name Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.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/humanname-partner-name
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.extension:partnerLastName.value[x] PartnerLastName Alternate namesAchternaamPartner DefinitionPartner’s official last name.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.name:nameInformation.family.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |||||||||||||||||||||||||||||
given | Σ | 1..* | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.given FirstName / Initial Alternate namesfirst name, middle name, Voornaam, Initiaal DefinitionOne of a person’s official first names or the initial if the full name is not known. This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way:
Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional Note 1: The GivenName concept should not be included here but in a separate Note 2: As specified by FHIR, multiple official first names MAY be combined in a single
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 1..* | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
givenOrInitial | I | 1..* | Extension(code) | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.extension:givenOrInitial LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV Alternate namesextensions, user content DefinitionA set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to indicate additional information about the name part and how it should be used. http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier Constraints
| ||||||||||||||||||||||||||||
value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.name:nameInformation.given.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |||||||||||||||||||||||||||||
prefix | Σ | 0..* | string | Element idPatient.name:nameInformation.prefix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
suffix | Σ | 0..* | string | Element idPatient.name:nameInformation.suffix Titles Alternate namesTitels DefinitionNoble and scientific titles. These can assist in formulating oral and formal addresing titles. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
period | Σ I | 0..1 | Period | Element idPatient.name:nameInformation.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
nameInformation-GivenName | Σ | 0..* | nl core NameInformation.GivenName | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName Name of a human - parts and usage Alternate namesnl-core-NameInformation.GivenName DefinitionThis slice represents the name information normally used to address the person. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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. nl core NameInformation.GivenName Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
use | Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
usual
| ||||||||||||||||||||||||||||
text | Σ | 0..1 | string | Element idPatient.name:nameInformation-GivenName.text Text representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
family | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.family Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
| ||||||||||||||||||||||||||||
given | Σ | 1..* | string | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.given GivenName Alternate namesfirst name, middle name, Roepnaam DefinitionThe name normally used to address the person. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
| ||||||||||||||||||||||||||||
prefix | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.prefix Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
| ||||||||||||||||||||||||||||
suffix | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.suffix Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size
| ||||||||||||||||||||||||||||
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name:nameInformation-GivenName.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
| ||||||||||||||||||||||||||||
telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom ContactInformation Alternate namesContactgegevens DefinitionPatient’s telephone number(s) or e-mail address(es). People have (primary) ways to contact them in some way such as phone, email. 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. Unordered, Open, by $this(Profile) Constraints
| ||||||||||||||||||||||||||||
telephoneNumbers | Σ I | 0..* | nl core ContactInformation TelephoneNumbers | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers TelephoneNumbers Alternate namesTelefoonnummers, nl-core-ContactInformation-TelephoneNumbers DefinitionContainer of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. People have (primary) ways to contact them in some way such as phone, email. 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 nl core ContactInformation TelephoneNumbers Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
comment | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.extension:comment 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/ext-Comment Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.extension:comment.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.extension:comment.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/ext-Comment
| |||||||||||||||||||||||||||||
value[x] | 0..1 | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.extension:comment.value[x] Comment Alternate namesToelichting DefinitionExplanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionnels) or that availability by phone is only possible during a specified part of the day.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
system | Σ I | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system TelecomType Alternate namesTelecomType DefinitionThe telecom or device type that the telephone number is connected to. Note that FHIR strings SHALL NOT exceed 1MB in size Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem. Permitted Values TelecomType_to_ContactInformation_TelephoneNumbersSystem Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
telecomType | I | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.extension:telecomType 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/ext-CodeSpecification Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.extension:telecomType.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.extension:telecomType.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.extension:telecomType.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/ext-CodeSpecification
| |||||||||||||||||||||||||||||
value[x] | 0..1 | Binding | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.extension:telecomType.value[x] TelecomType Alternate namesTelecomType DefinitionThe telecom or device type that the telephone number is connected to. TelecomTypeCodelijst (required) Constraints
| |||||||||||||||||||||||||||||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.system.value Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||||||||||||||||||||||||||||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:telephoneNumbers.value TelephoneNumber Alternate namesTelefoonnummer DefinitionThe person's telephone number. 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 idPatient.telecom:telephoneNumbers.use NumberType Alternate namesNummerSoort DefinitionNumberType indicates whether the number is a landline, temporary, work telephone number. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse. Permitted Values NummerSoortCodelijst_to_ContactInformation_TelephoneNumbersUse Constraints
| ||||||||||||||||||||||||||||
rank | Σ | 0..1 | positiveInt | Element idPatient.telecom:telephoneNumbers.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
period | Σ I | 0..1 | Period | Element idPatient.telecom:telephoneNumbers.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
emailAddresses | Σ I | 0..* | nl core ContactInformation EmailAddresses | There are no (further) constraints on this element Element idPatient.telecom:emailAddresses EmailAddresses Alternate namesEmailAdressen, nl-core-ContactInformation-EmailAddresses DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. People have (primary) ways to contact them in some way such as phone, email. The "EmailAddresses" concept of zib ContactInformation. nl core ContactInformation EmailAddresses Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:emailAddresses.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:emailAddresses.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
system | Σ I | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idPatient.telecom:emailAddresses.system Telecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
| ||||||||||||||||||||||||||||
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:emailAddresses.value EmailAddress Alternate namesEmailAdres DefinitionThe person's e-mail 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 idPatient.telecom:emailAddresses.use EmailAddressType Alternate namesEmailSoort DefinitionE-mailAddressType indicates whether it is a private or business e-mail address. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use ConceptMap NummerSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse. Permitted Values NummerSoortCodelijst_to_ContactInformation_EmailAddressesUse Constraints
| ||||||||||||||||||||||||||||
rank | Σ | 0..1 | positiveInt | Element idPatient.telecom:emailAddresses.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
period | Σ I | 0..1 | Period | Element idPatient.telecom:emailAddresses.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
gender | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.gender Gender Alternate namesGeslacht DefinitionPatient’s administrative gender. Needed for identification of the individual, in combination with (at least) name and birth date. 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. Use ConceptMap 'GeslachtCodelijst-to-AdministrativeGender' to translate zib terminology to profile terminology in ValueSet 'AdministrativeGender' Permitted Values GeslachtCodelijst_to_AdministrativeGender Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.gender.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.gender.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
genderCodelist | I | 0..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist 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/ext-CodeSpecification Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.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/ext-CodeSpecification
| |||||||||||||||||||||||||||||
value[x] | 0..1 | Binding | There are no (further) constraints on this element Element idPatient.gender.extension:genderCodelist.value[x] Gender Alternate namesGeslacht DefinitionPatient’s administrative gender. GeslachtCodelijst
| |||||||||||||||||||||||||||||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.gender.value Primitive value for code DefinitionPrimitive value for code System.String Maximum string length1048576 | |||||||||||||||||||||||||||||
birthDate | Σ | 1..1 | date | There are no (further) constraints on this element Element idPatient.birthDate DateOfBirth Alternate namesGeboortedatum DefinitionPatient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted. 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 maternity/infant care systems).
| ||||||||||||||||||||||||||||
deceased[x] | Σ ?! | 0..0 | There are no (further) constraints on this element Element idPatient.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. Unordered, Open, by $this(Type) Constraints
| |||||||||||||||||||||||||||||
address | Σ | 0..* | nl core AddressInformation | There are no (further) constraints on this element Element idPatient.address AddressInformation Alternate namesAdresgegevens, nl-core-AddressInformation DefinitionAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. 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.
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
addressType | I | 0..1 | Extension(CodeableConcept) | Element idPatient.address.extension:addressType Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. This element is not used in the context of Koppeltaal 2.0 http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType Constraints
| ||||||||||||||||||||||||||||
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.use AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. Use ConceptMap 'AdresSoortCodelijst-to-AddressUse' to translate zib terminology to profile terminology in ValueSet 'AddressUse' Permitted Values AdresSoortCodelijst_to_AddressUse Constraints
General home Mappings
| ||||||||||||||||||||||||||||
type | Σ | 0..1 | codeBinding | Element idPatient.address.type AddressType Alternate namesAdresSoort DefinitionThe type of address in question, such as a home address or mailing address. This element is not used in the context of Koppeltaal 2.0 Use ConceptMap 'AdresSoortCodelijst-to-AddressType' to translate zib terminology to profile terminology in ValueSet 'AddressType' Permitted Values AdresSoortCodelijst_to_AddressType Constraints
General both Mappings
| ||||||||||||||||||||||||||||
text | Σ | 0..1 | string | Element idPatient.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. This element is not used in the context of Koppeltaal 2.0
General 137 Nowhere Street, Erewhon 9132 Mappings
| ||||||||||||||||||||||||||||
line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.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. The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the
General 137 Nowhere Street Mappings
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
streetName | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName streetName Alternate namesextensions, user content DefinitionstreetName. 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
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.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
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.address.line.extension:streetName.value[x] Street Alternate namesStraat DefinitionStreet name of the address.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
houseNumber | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber houseNumber Alternate namesextensions, user content DefinitionThe number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.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
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumber.value[x] HouseNumber Alternate namesHuisnummer DefinitionHouse number of the address.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
houseNumberLetter-houseNumberAddition | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition buildingNumberSuffix Alternate namesextensions, user content DefinitionAny alphabetic character, fraction or other text that may appear after the numeric portion of a building 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-buildingNumberSuffix Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.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
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] HouseNumberLetter / HouseNumberAddition Alternate namesHuisnummerletter, Huisnummertoevoeging DefinitionExport:
Import
Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
houseNumberIndication | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication additionalLocator Alternate namesextensions, user content DefinitionThis can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.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
| |||||||||||||||||||||||||||||
value[x] | I | 1..1 | There are no (further) constraints on this element Element idPatient.address.line.extension:houseNumberIndication.value[x] HouseNumberIndication Alternate namesAanduidingBijNummer DefinitionThe indication used for addresses which do not consist of the usual street name and house number. The mapping of zib AddressInformation on the FHIR Address datatype is the result of compatibility with HL7v3, which is the format that a lot of healthcare data in the Netherlands is stored in. As a result of this, the coded zib HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to').
| |||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
additionalInformation | I | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation unitID Alternate namesextensions, user content DefinitionThe number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.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
| |||||||||||||||||||||||||||||
value[x] | 1..1 | There are no (further) constraints on this element Element idPatient.address.line.extension:additionalInformation.value[x] AdditionalInformation Alternate namesAdditioneleInformatie DefinitionExtra information such as the building name, building number, entrance, route number.
| ||||||||||||||||||||||||||||||
valueString | string | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address.line.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |||||||||||||||||||||||||||||
city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.city PlaceOfResidence Alternate namesMunicpality, Woonplaats DefinitionA geographically determined area which forms part of the municipal area. For Dutch places of residence, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14). Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
| ||||||||||||||||||||||||||||
district | Σ | 0..1 | string | Element idPatient.address.district Municipality Alternate namesCounty, Gemeente DefinitionMunicipality of residence. For Dutch municipalities, preferably use the name from the GBA, table 33 (OID: 2.16.840.1.113883.2.4.6.14). This element is not used in the context of Koppeltaal 2.0
General Madison Mappings
| ||||||||||||||||||||||||||||
state | Σ | 0..1 | string | Element idPatient.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). This element is not used in the context of Koppeltaal 2.0
| ||||||||||||||||||||||||||||
postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCode Postcode Alternate namesZip, Postcode DefinitionPostcode of the address. In Dutch addresses, preferably use the postcode from the Postcode table (OID: 2.16.840.1.113883.2.4.4.15). Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
| ||||||||||||||||||||||||||||
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. 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 CodeSpecification extension under
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
countryCode | I | 0..1 | Extension(CodeableConcept) | Element idPatient.address.country.extension:countryCode Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. See Koppeltaal Implementation Guide for more information. http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification Constraints
| ||||||||||||||||||||||||||||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country.extension:countryCode.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||||||||||||||||||||||||||||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.country.extension:countryCode.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. 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. 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) Extensions are always sliced by (at least) url Constraints
| ||||||||||||||||||||||||||||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.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/ext-CodeSpecification
| |||||||||||||||||||||||||||||
value[x] | 0..1 | Binding | Element idPatient.address.country.extension:countryCode.value[x] Country Alternate namesLand DefinitionCountry in which the address is located. See Koppeltaal Implementation Guide for more information.
| |||||||||||||||||||||||||||||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||||||||||||||||||||||||||||
value | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.address.country.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |||||||||||||||||||||||||||||
period | Σ I | 0..1 | Period | Element idPatient.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 element is not used in the context of Koppeltaal 2.0
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
| ||||||||||||||||||||||||||||
maritalStatus | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus MaritalStatus Alternate namesBurgerlijkeStaat DefinitionA person’s marital status according to the terms and definition in the Dutch civil code. 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. BurgerlijkeStaatCodelijst
| |||||||||||||||||||||||||||||
multipleBirth[x] | 0..0 | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) 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 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). Unordered, Open, by $this(Type) Constraints
| ||||||||||||||||||||||||||||||
photo | I | 0..0 | Attachment | There are no (further) constraints on this element Element idPatient.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. Guidelines:
| ||||||||||||||||||||||||||||
contact | I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.contact Contact Alternate namesContactpersoon DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. 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
| ||||||||||||||||||||||||||||
communication | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.communication LanguageProficiency Alternate namesTaalvaardigheid DefinitionA language 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 are 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.
| |||||||||||||||||||||||||||||
generalPractitioner | I | 0..0 | zib HealthProfessional Reference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner A reference from one resource to another Alternate namescareProvider DefinitionA reference from one resource to another. Each occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of nl-core-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of nl-core-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the zib-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile. zib HealthProfessional Reference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole) Constraints
| ||||||||||||||||||||||||||||
managingOrganization | Σ I | 0..1 | Reference(KT2_Organization) | Element idPatient.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..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.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 use cases:
There is no assumption that linked patient records have mutual links.
|
Country Codes
The section on country codes is moved because it is equally relevant for Providers and Healthcare professionals.