Home
Dit is een test
| Oefening2 (Patient) | C | Patient | There are no (further) constraints on this element Element idPatientShort description Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPatient.idShort description 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.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRulesShort description 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. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.languageShort description 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. Binding extensions
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.textShort description 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 may 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 in formation is added later. The cardinality or value of this element may be affected by these constraints: dom-1 Mappings
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.containedShort description 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.
| |||
| extension | 0..* | Extension | Element idPatient.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Mappings
| |||
| occupation | S C | 0..* | Extension(CodeableConcept) | Element idPatient.extension:occupationShort description 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://marcels.example.org/fhir/StructureDefinition/OccupationExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:occupation.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:occupation.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:occupation.urlShort description 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://marcels.example.org/fhir/StructureDefinition/OccupationExtensionMappings
| |||
| valueCodeableConcept | 0..1 | CodeableConceptBinding | Element idPatient.extension:occupation.valueCodeableConcept:valueCodeableConceptShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |||
| geboortePlaats | S C | 0..1 | Extension(Address) | Element idPatient.extension:geboortePlaatsShort description Place of Birth for patient Alternate namesextensions, user content DefinitionThe registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements. 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/birthPlace ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:geboortePlaats.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension:geboortePlaats.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.extension:geboortePlaats.urlShort description 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/birthPlaceMappings
| |||
| valueAddress | 0..1 | Address | There are no (further) constraints on this element Element idPatient.extension:geboortePlaats.valueAddress:valueAddressShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |||
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtensionShort description 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
| ||
| identifier | Σ | 1..* | Identifier | Element idPatient.identifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers. Unordered, Open, by system(Value) Mappings
| ||
| officialIdentifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idPatient.identifier:officialIdentifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:officialIdentifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:officialIdentifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:officialIdentifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . Fixed valueofficialMappings
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:officialIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Mappings
| ||
| system | Σ | 1..1 | uriFixed Value | Element idPatient.identifier:officialIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. http://national.registry.org/idsExamples General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:officialIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. General 123456Mappings
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:officialIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:officialIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
| ||
| hospitalIdentifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier:hospitalIdentifierShort description An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:hospitalIdentifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:hospitalIdentifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.identifier:hospitalIdentifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . Fixed valueofficialMappings
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:hospitalIdentifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Mappings
| ||
| system | Σ | 1..1 | uriFixed Value | Element idPatient.identifier:hospitalIdentifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. http://erasmusmc.nl/pidExamples General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uriMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:hospitalIdentifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. General 123456Mappings
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:hospitalIdentifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:hospitalIdentifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
| ||
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.activeShort description Whether this patient's record is in active use DefinitionWhether this patient record is in active use. Need to be able to mark a patient record as not to be used because it was created in error. Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active. trueMappings
| ||
| name | Σ C | 1..* | nl-core-humanname | Element idPatient.nameShort description Name of a human - parts and usage DefinitionA human's name with the ability to identify parts and usage. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. A Dutch HumanName is a proper FHIR HumanName. Systems that do not understand any of the extensions, will be able to render and work with a Dutch name. Dutch names make certain name parts seaprately communicable. These parts are required for use in true Dutch systems when dealing with Dutch names, but may not have value for international systems when information gets sent abroad. To have true compatibility an implementer SHOULD use the core HumanName parts as intended. To have names work for Dutch context, the implementer SHOULD in addition use the extension elements. The extension elements cover birth name (NL: eigennaam / geslachtsnaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around. For this reason, there are extensions for marking each part for what it is. Example: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas family = "Jongeneel-de Haas" given = "Irma" humanname-own-name = "Jongeneel" humanname-partner-prefix = "de " humanname-partner-name = "Haas" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
Structured HumanName (preferred above unstructured) {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
"valueCode": "NL4"
}
],
"use": "official",
"family": "Jongeneel-de Haas",
"_family": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"valueString": "Jongeneel"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
"valueString": "de"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
"valueString": "Haas"
}
]
},
"given": [
"Irma",
"I."
],
"_given": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "CL"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode": "IN"
}
]
}
]
}Unstructured HumanName{
"use": "official",
"text": "Irma Jongeneel-de Haas"
}Mappings
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| humannameAssemblyOrder | C | 0..1 | Extension(code) | There are no (further) constraints on this element Element idPatient.name.extension:humannameAssemblyOrderShort description Preferred display order of name parts Alternate namesextensions, user content, Voorkeursvolgorde van de naamdelen. 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.extension:humannameAssemblyOrder.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension:humannameAssemblyOrder.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name.extension:humannameAssemblyOrder.urlShort description 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-orderMappings
| |||
| valueCode | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.extension:humannameAssemblyOrder.value[x]:valueCodeShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A code that represents the preferred display order of the components of a human name HumanNameAssemblyOrder (required) Mappings
| |||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.useShort description 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. This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name Mappings
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.textShort description Text representation of the full name DefinitionA full text representation of the name. A renderable, unencoded form. Can provide both a text representation and structured parts.
| ||
| family | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name.familyShort description Surname Alternate namessurname, Achternaam 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.family.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references) | |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.family.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) | |||
| humannameOwnPrefix | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnPrefixShort description PrefixOwnName Alternate namesextensions, user content, VoorvoegselGeslachtsnaam DefinitionThe prefix portion (e.g. voorvoegsel) inclusive of the space between the prefix and the surname, if applicable, 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnPrefix.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnPrefix.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnPrefix.urlShort description 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-prefixMappings
| |||
| valueString | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnPrefix.value[x]:valueStringShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |||
| humannameOwnName | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnNameShort description OwnName Alternate namesextensions, user content, Geslachtsnaam DefinitionThe person’s official last name. The 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnName.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnName.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnName.urlShort description 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-nameMappings
| |||
| valueString | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannameOwnName.value[x]:valueStringShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |||
| humannamePartnerPrefix | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerPrefixShort description PrefixSurname Alternate namesextensions, user content, VoorvoegselGeslachtsnaamPartner DefinitionVoorvoegsel derived from person's partner's surname inclusive of the space between the prefix and the surname, if applicable. 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerPrefix.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerPrefix.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerPrefix.urlShort description 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-prefixMappings
| |||
| valueString | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerPrefix.value[x]:valueStringShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |||
| humannamePartnerName | C | 0..1 | Extension(string) | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerNameShort description LastNamePartner Alternate namesextensions, user content, GeslachtsnaamPartner DefinitionPartner’s official last name. The 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerName.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerName.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerName.urlShort description 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-nameMappings
| |||
| valueString | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family.extension:humannamePartnerName.value[x]:valueStringShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| |||
| value | 0..1 | There are no (further) constraints on this element Element idPatient.name.family.valueShort description Primitive value for string DefinitionThe actual value 1048576 | ||||
| given | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.name.givenShort description Given Alternate namesfirst name, middle name, Voornamen, Initialen, Roepnaam DefinitionNote that in order to mark the type of a given name, that you use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include call me name (Dutch: roepnaam) and initials. Each initial is expected to be delimited by a dot. To be conformant to the Zib for NameInformation, at least the following qualifiers SHALL be supported: BR, IN and CL. The qualifier 'BR' maps to the Zib concept FirstNames, 'IN' maps to Initials and 'CL' to GivenName.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.given.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references) | |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.given.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) | |||
| iso21090EnQualifier | C | 0..1 | Extension(code) | There are no (further) constraints on this element Element idPatient.name.given.extension:iso21090EnQualifierShort description 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.given.extension:iso21090EnQualifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.given.extension:iso21090EnQualifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPatient.name.given.extension:iso21090EnQualifier.urlShort description 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-EN-qualifierMappings
| |||
| valueCode | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.given.extension:iso21090EnQualifier.value[x]:valueCodeShort description Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type EntityNamePartQualifier (required) Mappings
| |||
| value | 0..1 | There are no (further) constraints on this element Element idPatient.name.given.valueShort description Primitive value for string DefinitionThe actual value 1048576 | ||||
| prefix | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.prefixShort description 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.
| ||
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffixShort description 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.
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.periodShort description 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.
| ||
| telecom | Σ | 1..* | ContactPoint | Element idPatient.telecomShort description A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). Unordered, Open, by use(Value) Mappings
| ||
| privateNumber | Σ | 1..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:privateNumberShort description A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:privateNumber.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:privateNumber.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:privateNumber.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Mappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:privateNumber.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:privateNumber.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point Fixed valuehomeMappings
| ||
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:privateNumber.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:privateNumber.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
| workNumber | Σ | 0..1 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom:workNumberShort description A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom:workNumber.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom:workNumber.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom:workNumber.systemShort description phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Telecommunications form for contact point ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Mappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.telecom:workNumber.valueShort description The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idPatient.telecom:workNumber.useShort description home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point Fixed valueworkMappings
| ||
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom:workNumber.rankShort description Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom:workNumber.periodShort description Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
| ||
| gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes. The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error. The gender of a person used for administrative purposes. AdministrativeGender (required) Mappings
| ||
| birthDate | Σ | 1..1 | date | There are no (further) constraints on this element Element idPatient.birthDateShort description The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems).
| ||
| deceased[x] | Σ ?! | 0..1 | There are no (further) constraints on this element Element idPatient.deceased[x]Short description Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
| |||
| deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| deceasedDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| address | Σ C | 0..* | Address | Element idPatient.addressShort description Addresses for the individual DefinitionAddresses for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Patient may have multiple addresses with different uses or applicable periods.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |||
| use | Σ ?! C | 0..1 | codeBinding | Element idPatient.address.useShort description home | work | temp | old - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address ConditionsThe cardinality or value of this element may be affected by these constraints: temp-adres-period-exists ExamplesGeneral homeMappings
| ||
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.typeShort description postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. The type of an address (physical / postal) ExamplesGeneral bothMappings
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.textShort description Text representation of the address DefinitionA full text representation of the address. A renderable, unencoded form. Can provide both a text representation and parts. General 137 Nowhere Street, Erewhon 9132Mappings
| ||
| line | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.address.lineShort description Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. home | work | temp | old - purpose of this address. General 137 Nowhere StreetMappings
| ||
| city | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.cityShort description Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center. General ErewhonMappings
| ||
| district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.districtShort description District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. General MadisonMappings
| ||
| state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.stateShort description 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 (i.e. US 2 letter state codes).
| ||
| postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCodeShort description Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. General 9132Mappings
| ||
| country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.countryShort description Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a full country name.
| ||
| period | Σ C | 0..1 | Period | Element idPatient.address.periodShort description Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. The cardinality or value of this element may be affected by these constraints: temp-adres-period-exists ExamplesGeneral {
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings
| ||
| maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatusShort description Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. The domestic partnership status of a person. Marital Status Codes (extensible) Mappings
| |||
| multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x]Short description Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).
| ||||
| multipleBirthBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| multipleBirthInteger | integer | There are no (further) constraints on this element Data type | ||||
| photo | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photoShort description 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.
| |||
| contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contactShort description A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| |||
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
| ||
| relationship | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.contact.relationshipShort description The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. The nature of the relationship between a patient and a contact person for that patient. http://hl7.org/fhir/ValueSet/v2-0131 (extensible) Mappings
| |||
| name | 0..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.nameShort description A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
| |||
| telecom | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecomShort description A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
| |||
| address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.addressShort description Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited.
| |||
| gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. The gender of a person used for administrative purposes. AdministrativeGender (required) Mappings
| |||
| organization | C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organizationShort description Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. The cardinality or value of this element may be affected by these constraints: pat-1 Mappings
| ||
| period | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.periodShort description The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient.
| |||
| animal | Σ ?! | 0..1 | BackboneElement | There are no (further) constraints on this element Element idPatient.animalShort description This patient is known to be an animal (non-human) DefinitionThis patient is known to be an animal. Many clinical systems are extended to care for animal patients as well as human. The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.animal.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.animal.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| |||
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.animal.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
| ||
| species | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idPatient.animal.speciesShort description E.g. Dog, Cow DefinitionIdentifies the high level taxonomic categorization of the kind of animal. Need to know what kind of animal. If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.). The species of an animal. Mappings
| ||
| breed | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idPatient.animal.breedShort description E.g. Poodle, Angus DefinitionIdentifies the detailed categorization of the kind of animal. May need to know the specific kind within the species. Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type. The breed of an animal. Mappings
| ||
| genderStatus | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idPatient.animal.genderStatusShort description E.g. Neutered, Intact DefinitionIndicates the current state of the animal's reproductive organs. Gender status can affect housing and animal behavior. The state of the animal's reproductive organs. Mappings
| ||
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communicationShort description A list of Languages which may be used to communicate with the patient about his or her health DefinitionLanguages which may be used to communicate with the patient about his or her health. If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| |||
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
| ||
| language | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.languageShort description The language which can be used to communicate with the patient about his or her health DefinitionThe ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language. Binding extensions
| |||
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferredShort description Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. This language is specifically identified for communicating healthcare information.
| |||
| generalPractitioner | 0..* | Reference(nl-core-practitioner) | Element idPatient.generalPractitionerShort description Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Reference(nl-core-practitioner) Mappings
| |||
| managingOrganization | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganizationShort description Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).
| ||
| link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.linkShort description Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple usecases:
There is no assumption that linked patient records have mutual links. This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| |||
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for 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.
| ||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.otherShort description The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Mappings
| ||
| type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.typeShort description replaced-by | replaces | refer | seealso - type of link DefinitionThe type of link between this patient resource and another patient resource. The type of link between this patient resource and another patient resource. Mappings
|