UKCorePatient (Patient) | C | | Patient | There are no (further) constraints on this element Element idPatient Short descriptionInformation 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.
Data typePatient Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() Mappings- rim: Entity. Role, or Act
- rim: Patient[classCode=PAT]
- cda: ClinicalDocument.recordTarget.patientRole
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Short descriptionMetadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Short descriptionContained, 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.
CommentsThis should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Data typeResource Mappings |
extension | C | 0..* | Extension | Element idPatient.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
birthPlace | C | 0..1 | Extension(Address) | Element idPatient.extension:birthPlace Short descriptionThe registered place of birth of the patient. Alternate namesextensions, user content DefinitionThe registered place of birth of the patient.
CommentsThere 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.
Data typeExtension(Address) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-birthPlace ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:birthPlace.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:birthPlace.extension Short descriptionExtension DefinitionData typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idPatient.extension:birthPlace.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuehttp://hl7.org/fhir/StructureDefinition/patient-birthPlace Mappings |
value[x] | | 1..1 | | Element idPatient.extension:birthPlace.value[x] Short descriptionThe registered place of birth of the patient. DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueAddress | | | Address | There are no (further) constraints on this element Data typeAddress |
birthSex | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:birthSex Short descriptionThe patient's phenotypic sex at birth. Alternate namesextensions, user content DefinitionThe patient's phenotypic sex at birth.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
cadavericDonor | C | 0..1 | Extension(boolean) | Element idPatient.extension:cadavericDonor Short descriptionPost-mortem donor status. Alternate namesextensions, user content DefinitionFlag indicating whether the patient authorized the donation of body parts after death.
CommentsThere 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.
Data typeExtension(boolean) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-cadavericDonor ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:cadavericDonor.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:cadavericDonor.extension Short descriptionExtension DefinitionData typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idPatient.extension:cadavericDonor.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuehttp://hl7.org/fhir/StructureDefinition/patient-cadavericDonor Mappings |
value[x] | | 1..1 | | Element idPatient.extension:cadavericDonor.value[x] Short descriptionPost-mortem donor status. DefinitionFlag indicating whether the patient authorized the donation of body parts after death.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
contactPreference | C | 0..1 | Extension(Complex) | Element idPatient.extension:contactPreference Short descriptionThe preferred method of contact, contact times and written communication format given by a Patient or Related Person. Alternate namesextensions, user content DefinitionThe preferred method of contact, contact times and written communication format given by a Patient or Related Person.
CommentsThere 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.
Data typeExtension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
deathNotificationStatus | C | 0..1 | Extension(Complex) | Element idPatient.extension:deathNotificationStatus Short descriptionThe patient's death notification status. Alternate namesextensions, user content DefinitionThe patient's death notification status.
CommentsThere 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.
Data typeExtension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
ethnicCategory | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:ethnicCategory Short descriptionThe ethnicity of the subject Alternate namesextensions, user content DefinitionThe ethnicity of the subject.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
residentialStatus | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:residentialStatus Short descriptionThe residential status of the patient. Alternate namesextensions, user content DefinitionThe residential status of the patient. For example if this patient is a UK resident.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
patientInterpreterRequired | C | 0..1 | Extension(boolean) | Element idPatient.extension:patientInterpreterRequired Short descriptionWhether the patient needs an interpreter Alternate namesextensions, user content DefinitionThis Patient requires an interpreter to communicate healthcare information to the practitioner.
CommentsThe Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.
Data typeExtension(boolean) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-interpreterRequired ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.extension:patientInterpreterRequired.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.extension:patientInterpreterRequired.extension Short descriptionExtension DefinitionData typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idPatient.extension:patientInterpreterRequired.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuehttp://hl7.org/fhir/StructureDefinition/patient-interpreterRequired Mappings |
value[x] | | 1..1 | | Element idPatient.extension:patientInterpreterRequired.value[x] Short descriptionIndicator showing whether the patient needs an interpreter DefinitionIndicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
nhsNumberUnavailableReason | C | 0..1 | Extension(CodeableConcept) | Element idPatient.extension:nhsNumberUnavailableReason Short descriptionReason why this Patient does not include an NHS Number identifier Alternate namesextensions, user content DefinitionThe reason why a patient does not have an NHS Number. For example if this patient is an overseas patient.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | S Σ | 0..* | Identifier | Element idPatient.identifier Short descriptionAn identifier for this patient DefinitionAn identifier for this patient.
RequirementsPatients are almost always assigned specific numerical identifiers.
Data typeIdentifier SlicingUnordered, Open, by system(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.identifier
- v2: PID-3
- rim: id
- cda: .id
|
nhsNumber | Σ | 0..1 | Identifier | Element idPatient.identifier:nhsNumber Short descriptionThe patient's NHS number DefinitionAn identifier for this patient.
RequirementsPatients are almost always assigned specific numerical identifiers.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.identifier
- v2: PID-3
- rim: id
- cda: .id
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
nhsNumberVerificationStatus | C | 0..1 | Extension(CodeableConcept) | Element idPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatus Short descriptionNHS number verification status Alternate namesextensions, user content DefinitionThe verification/tracing status of the NHS number.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.use Short descriptionusual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier.
RequirementsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
CommentsApplications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data typecode BindingIdentifies the purpose for this identifier, if known .
IdentifierUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.type Short descriptionDescription of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
RequirementsAllows users to make use of identifiers when the identifier system is not known.
CommentsThis 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.
Data typeCodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Identifier Type Codes (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: CX.5
- rim: Role.code or implied by context
|
system | S Σ | 1..1 | uriAuto Value | Element idPatient.identifier:nhsNumber.system Short descriptionThe namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
RequirementsThere 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.
CommentsIdentifier.system is always case sensitive.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Auto valuehttps://fhir.nhs.uk/Id/nhs-number Examples Generalhttp://www.acme.com/identifiers/patient Mappings- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.value Short descriptionThe value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
CommentsIf 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General123456 Mappings- v2: CX.1 / EI.1
- rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd: ./Value
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.period Short descriptionTime period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: CX.7 + CX.8
- rim: Role.effectiveTime or implied by context
- servd: ./StartDate and ./EndDate
|
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.identifier:nhsNumber.assigner Short descriptionOrganization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier.
CommentsThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data typeReference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: CX.4 / (CX.4,CX.9,CX.10)
- rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd: ./IdentifierIssuingAuthority
|
active | S Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.active Short descriptionWhether this patient's record is in active use DefinitionWhether this patient record is in active use.
Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.
It is often used to filter patient lists to exclude inactive patients
Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
RequirementsNeed to be able to mark a patient record as not to be used because it was created in error.
CommentsIf a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
Meaning when missingThis resource is generally assumed to be active if no value is provided for the active element
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.status
- rim: statusCode
- cda: n/a
|
name | S Σ | 0..* | HumanName | There are no (further) constraints on this element Element idPatient.name Short descriptionA name associated with the patient DefinitionA name associated with the individual.
RequirementsNeed to be able to track the patient by multiple names. Examples are your official name and a partner name.
CommentsA patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
Data typeHumanName Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.name.use Short descriptionusual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name.
RequirementsAllows the appropriate name for a particular context of use to be selected from among a set of names.
CommentsApplications can assume that a name is current unless it explicitly says that it is temporary or old.
Data typecode BindingNameUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.7, but often indicated by which field contains the name
- rim: unique(./use)
- servd: ./NamePurpose
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.text Short descriptionText representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
RequirementsA renderable, unencoded form.
CommentsCan provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: implied by XPN.11
- rim: ./formatted
|
family | S Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.family Short descriptionFamily name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
CommentsFamily Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.1/FN.1
- rim: ./part[partType = FAM]
- servd: ./FamilyName
|
given | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.given Short descriptionGiven names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionCommentsIf only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.2 + XPN.3
- rim: ./part[partType = GIV]
- servd: ./GivenNames
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefix Short descriptionParts 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.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.5
- rim: ./part[partType = PFX]
- servd: ./TitleCode
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffix Short descriptionParts 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.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN/4
- rim: ./part[partType = SFX]
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.period Short descriptionTime period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person.
RequirementsAllows names to be placed in historical context.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XPN.13 + XPN.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
telecom | S Σ | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom Short descriptionA contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsA Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
Data typeContactPoint Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-13, PID-14, PID-40
- rim: telecom
- cda: .telecom
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
system | S Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
Data typecode BindingTelecommunications form for contact point.
ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.system.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | Element idPatient.telecom.system.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
otherContactSystem | C | 0..1 | Extension(CodeableConcept) | Element idPatient.telecom.system.extension:otherContactSystem Short descriptionOther contact system Alternate namesextensions, user content DefinitionOther contact system value which extends the system element in the ContactPoint datatype.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.telecom.system.value Short descriptionPrimitive value for code DefinitionData typeSystem.String |
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.value Short descriptionThe 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).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.telecom.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingContactPointUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.telecom.rank Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.telecom.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
gender | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
RequirementsNeeded for identification of the individual, in combination with (at least) name and birth date.
CommentsThe gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.
Data typecode BindingThe gender of a person used for administrative purposes.
AdministrativeGender (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-8
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: .patient.administrativeGenderCode
|
birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idPatient.birthDate Short descriptionThe date of birth for the individual DefinitionThe date of birth for the individual.
RequirementsAge of the individual drives many clinical processes.
CommentsAt least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).
Data typedate Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-7
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
- cda: .patient.birthTime
- loinc: 21112-8
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | Element idPatient.birthDate.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
birthTime | C | 0..1 | Extension(dateTime) | Element idPatient.birthDate.extension:birthTime Short descriptionTime of day of birth. Alternate namesextensions, user content DefinitionThe time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
CommentsThere 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.
Data typeExtension(dateTime) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-birthTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.birthDate.extension:birthTime.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.birthDate.extension:birthTime.extension Short descriptionExtension DefinitionData typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idPatient.birthDate.extension:birthTime.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuehttp://hl7.org/fhir/StructureDefinition/patient-birthTime Mappings |
value[x] | | 1..1 | | Element idPatient.birthDate.extension:birthTime.value[x] Short descriptionTime of day of birth. DefinitionThe time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
value | | 0..1 | System.Date | There are no (further) constraints on this element Element idPatient.birthDate.value Short descriptionPrimitive value for date DefinitionData typeSystem.Date |
deceased[x] | Σ ?! | 0..1 | | There are no (further) constraints on this element Element idPatient.deceased[x] Short descriptionIndicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not.
RequirementsThe 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.
CommentsIf 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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
|
deceasedBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
deceasedDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
address | S Σ | 0..* | Address | Element idPatient.address Short descriptionAn address for the individual DefinitionAn address for the individual
RequirementsMay need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
CommentsPatient may have multiple addresses with different uses or applicable periods.
Data typeAddress Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-11
- rim: addr
- cda: .addr
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.address.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
addressKey | C | 0..* | Extension(Complex) | Element idPatient.address.extension:addressKey Short descriptionA patient's address key and type Alternate namesextensions, user content DefinitionA patient's address key and type.
CommentsThere 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.
Data typeExtension(Complex) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.use Short descriptionhome | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address.
RequirementsAllows an appropriate address to be chosen from a list of many.
CommentsApplications can assume that an address is current unless it explicitly says that it is temporary or old.
Data typecode BindingAddressUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalhome Mappings- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.address.type Short descriptionpostal | 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.
CommentsThe definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).
Data typecode BindingThe type of an address (physical / postal).
AddressType (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalboth Mappings- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.text Short descriptionText representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
RequirementsA renderable, unencoded form.
CommentsCan provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General137 Nowhere Street, Erewhon 9132 Mappings- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
line | S Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.address.line Short descriptionStreet 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.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General137 Nowhere Street Mappings- v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
- rim: AD.part[parttype = AL]
- vcard: street
- servd: ./StreetAddress (newline delimitted)
|
city | S Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.city Short descriptionName of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples GeneralErewhon Mappings- v2: XAD.3
- rim: AD.part[parttype = CTY]
- vcard: locality
- servd: ./Jurisdiction
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.district Short descriptionDistrict name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county).
CommentsDistrict 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.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples GeneralMadison Mappings- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
state | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.state Short descriptionSub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
postalCode | S Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.postalCode Short descriptionPostal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General9132 Mappings- v2: XAD.5
- rim: AD.part[parttype = ZIP]
- vcard: code
- servd: ./PostalIdentificationCode
|
country | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.country Short descriptionCountry (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted.
CommentsISO 3166 3 letter codes can be used in place of a human readable country name.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.address.period Short descriptionTime period when address was/is in use DefinitionTime period when address was/is in use.
RequirementsAllows addresses to be placed in historical context.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General{
"start": "2010-03-23",
"end": "2010-07-01"
} Mappings- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
maritalStatus | | 0..1 | CodeableConceptBinding | Element idPatient.maritalStatus Short descriptionMarital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status.
RequirementsMost, if not all systems capture it.
Data typeCodeableConcept BindingAn indicator to identify the legal marital status of a person
UKCorePersonMaritalStatusCode (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-16
- rim: player[classCode=PSN]/maritalStatusCode
- cda: .patient.maritalStatusCode
|
multipleBirth[x] | | 0..1 | | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Short descriptionWhether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
RequirementsFor disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
CommentsWhere the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-24 (bool), PID-25 (integer)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
- cda: n/a
|
multipleBirthBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
multipleBirthInteger | | | integer | There are no (further) constraints on this element Data typeinteger |
photo | | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photo Short descriptionImage of the patient DefinitionRequirementsMany EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
CommentsGuidelines:
- Use id photos, not clinical photos.
- Limit dimensions to thumbnail.
- Keep byte count low to ease resource updates.
Data typeAttachment Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: OBX-5 - needs a profile
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
- cda: n/a
|
contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contact Short descriptionA contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient.
RequirementsNeed to track people you can contact about the patient.
CommentsContact 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.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - pat-1: SHALL at least contain a contact's details or a reference to an organization
name.exists() or telecom.exists() or address.exists() or organization.exists() Mappings- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
- cda: n/a
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | Element idPatient.contact.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
contactRank | C | 0..1 | Extension(positiveInt) | Element idPatient.contact.extension:contactRank Short descriptionPreferred ranking or order of contact applied to a contact on a patient's contact list Alternate namesextensions, user content DefinitionThe preferred ranking or order of contact applied to a contact on a patient's contact list.
CommentsThere 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.
Data typeExtension(positiveInt) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
copyCorrespondenceIndicator | C | 0..1 | Extension(boolean) | Element idPatient.contact.extension:copyCorrespondenceIndicator Short descriptionIndicator showing that a patient's contact or related person SHALL be copied in to patient correspondence Alternate namesextensions, user content DefinitionExtension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence.
CommentsThere 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.
Data typeExtension(boolean) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
relationship | | 0..* | CodeableConceptBinding | Element idPatient.contact.relationship Short descriptionThe kind of relationship DefinitionThe nature of the relationship between the patient and the contact person.
RequirementsUsed to determine which contact person is the most relevant to approach, depending on circumstances.
Data typeCodeableConcept BindingThe nature of the relationship between a patient and a contact person for that patient.
UKCorePersonRelationshipType (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-7, NK1-3
- rim: code
- cda: n/a
|
name | | 0..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.name Short descriptionA name associated with the contact person DefinitionA name associated with the contact person.
RequirementsContact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
Data typeHumanName Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-2
- rim: name
- cda: n/a
|
telecom | | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom Short descriptionA contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsContact 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.
Data typeContactPoint Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-5, NK1-6, NK1-40
- rim: telecom
- cda: n/a
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
system | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.system Short descriptionphone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
Data typecode BindingTelecommunications form for contact point.
ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.system.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references)
Data typestring |
extension | C | 0..* | Extension | Element idPatient.contact.telecom.system.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
otherContactSystem | C | 0..1 | Extension(CodeableConcept) | Element idPatient.contact.telecom.system.extension:otherContactSystem Short descriptionOther contact system Alternate namesextensions, user content DefinitionOther contact system value which extends the system element in the ContactPoint datatype.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
value | | 0..1 | System.String | There are no (further) constraints on this element Element idPatient.contact.telecom.system.value Short descriptionPrimitive value for code DefinitionData typeSystem.String |
value | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.value Short descriptionThe 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).
RequirementsNeed to support legacy numbers that are not in a tightly controlled format.
CommentsAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.1 (or XTN.12)
- rim: ./url
- servd: ./Value
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.telecom.use Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
RequirementsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
CommentsApplications can assume that a contact is current unless it explicitly says that it is temporary or old.
Data typecode BindingContactPointUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: XTN.2 - but often indicated by field
- rim: unique(./use)
- servd: ./ContactPointPurpose
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idPatient.contact.telecom.rank Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
CommentsNote that rank does not necessarily follow the order in which the contacts are represented in the instance.
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.telecom.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
address | | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.address Short descriptionAddress for the contact person DefinitionAddress for the contact person.
RequirementsNeed to keep track where the contact person can be contacted per postal mail or visited.
Data typeAddress Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-4
- rim: addr
- cda: n/a
|
gender | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
RequirementsNeeded to address the person correctly.
Data typecode BindingThe gender of a person used for administrative purposes.
AdministrativeGender (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-15
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: n/a
|
organization | C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Short descriptionOrganization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working.
RequirementsFor guardians or business related contacts, the organization is relevant.
Data typeReference(Organization) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
- rim: scoper
- cda: n/a
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.period Short descriptionThe 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.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: effectiveTime
- cda: n/a
|
communication | | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communication Short descriptionA language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health.
RequirementsIf a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.
CommentsIf 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.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: LanguageCommunication
- cda: patient.languageCommunication
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | Element idPatient.communication.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
proficiency | C | 0..1 | Extension(Complex) | Element idPatient.communication.extension:proficiency Short descriptionProficiency level of the communication Alternate namesextensions, user content DefinitionProficiency level of the communication.
CommentsThere 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.
Data typeExtension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/patient-proficiency ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
level | C | 0..1 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:level Short descriptionThe proficiency level of the communication DefinitionHow well the patient can communicate this communication (good, poor, etc.).
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:level.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:level.extension Short descriptionExtension DefinitionData typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:level.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuelevel Mappings |
value[x] | | 1..1 | Binding | Element idPatient.communication.extension:proficiency.extension:level.value[x] Short descriptionThe proficiency level for the communication DefinitionThe proficiency level for the communication.
BindingThe proficiency level for the communication.
v3.LanguageAbilityProficiency (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueCoding | | | Coding | There are no (further) constraints on this element Data typeCoding |
type | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:type Short descriptionThe proficiency type of the communication DefinitionWhat type of communication for the proficiency (spoken, written, etc.).
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:type.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:type.extension Short descriptionExtension DefinitionData typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
|
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.extension:type.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuetype Mappings |
value[x] | | 1..1 | Binding | Element idPatient.communication.extension:proficiency.extension:type.value[x] Short descriptionThe proficiency type for the communication DefinitionThe proficiency type for the communication.
BindingThe proficiency type for the communication.
v3.LanguageAbilityMode (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueCoding | | | Coding | There are no (further) constraints on this element Data typeCoding |
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuehttp://hl7.org/fhir/StructureDefinition/patient-proficiency Mappings |
value[x] | | 0..0 | | There are no (further) constraints on this element Element idPatient.communication.extension:proficiency.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
language | | 1..1 | CodeableConceptBinding | Element idPatient.communication.language Short descriptionA ValueSet that identifies the language used by a person. DefinitionA ValueSet that identifies the language used by a person.
RequirementsMost systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
CommentsThe 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.
Data typeCodeableConcept BindingA ValueSet that identifies the language used by a person.
AllLanguages (required) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-15, LAN-2
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
- cda: .languageCode
|
preferred | | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Short descriptionLanguage preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).
RequirementsPeople 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.
CommentsThis language is specifically identified for communicating healthcare information.
Data typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-15
- rim: preferenceInd
- cda: .preferenceInd
|
generalPractitioner | | 0..* | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitioner Short descriptionPatient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider.
CommentsThis may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.
Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.
Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.
Data typeReference(Organization | Practitioner | PractitionerRole) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PD1-4
- rim: subjectOf.CareEvent.performer.AssignedEntity
- cda: n/a
|
managingOrganization | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Short descriptionOrganization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record.
RequirementsNeed to know who recognizes this patient record, manages and updates it.
CommentsThere 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).
Data typeReference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: scoper
- cda: .providerOrganization
|
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.link Short descriptionLink to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient.
RequirementsThere are multiple use cases:
- Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
- Distribution of patient information across multiple servers.
CommentsThere is no assumption that linked patient records have mutual links.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: outboundLink
- cda: n/a
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
RequirementsModifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.other Short descriptionThe other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to.
CommentsReferencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.
Data typeReference(Patient | RelatedPerson) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: PID-3, MRG-1
- rim: id
- cda: n/a
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.type Short descriptionreplaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource.
Data typecode BindingThe type of link between this patient resource and another patient resource.
LinkType (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |