| RelatedPerson | I | | RelatedPerson | There are no (further) constraints on this element Element IdShort description A person that is related to a patient, but who is not a direct target of care Definition Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
RelatedPerson Constraints- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6:A resource should have narrative for robust management
text.`div`.exists() - dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
- rim:Entity. Role, or Act
- rim:role
|
| extension | I | 0..* | Extension | Element IdShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, 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()
|
| contactPreference | I | 0..1 | Extension(Complex) | Element IdRelatedPerson.extension:contactPreference The preferred method of contact, contact times and written communication format given by a Patient or Related Person. Alternate names extensions, user content Definition The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension(Complex) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference 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()
|
| copyCorrespondenceIndicator | I | 0..1 | Extension(boolean) | Element IdRelatedPerson.extension:copyCorrespondenceIndicator Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence Alternate names extensions, user content Definition Extension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension(boolean) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator 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()
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdShort description A human identifier for this person Definition Identifier for a person within a particular scope.
People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- w5:FiveWs.identifier
- v2:NK1-33
- rim:.id
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdRelatedPerson.identifier.use usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
code Binding Identifies 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())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdRelatedPerson.identifier.type Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Allows users to make use of identifiers when the identifier system is not known.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
CodeableConcept Binding A 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())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdRelatedPerson.identifier.system The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Identifier.system is always case sensitive.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdRelatedPerson.identifier.value The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- 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 | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdRelatedPerson.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdRelatedPerson.identifier.assigner Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- 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 | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdShort description Whether this related person's record is in active use Definition Whether this related person record is in active use.
Need to be able to mark a related person record as not to be used, such as if it was created in error.
This element is labeled as a modifier because it may be used to mark that the resource was created in error.
boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- w5:FiveWs.status
- rim:.statusCode
|
| patient | Σ I | 1..1 | Reference(UK Core Patient) | Element IdShort description The patient this person is related to Definition The patient this person is related to.
We need to know which patient this RelatedPerson is related to.
References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Reference(UK Core Patient) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:PID-3
- rim:scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
|
| reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdRelatedPerson.patient.reference Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdRelatedPerson.patient.type Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdRelatedPerson.patient.identifier Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdRelatedPerson.patient.identifier.use usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
code Binding Identifies 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())
- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdRelatedPerson.patient.identifier.type Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Allows users to make use of identifiers when the identifier system is not known.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
CodeableConcept Binding A 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())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdRelatedPerson.patient.identifier.system The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Identifier.system is always case sensitive.
uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient
Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdRelatedPerson.patient.identifier.value The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. 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.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- 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 | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdRelatedPerson.patient.identifier.period Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdRelatedPerson.patient.identifier.assigner Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- 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
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdRelatedPerson.patient.display Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| relationship | Σ | 0..* | CodeableConceptBinding | Element IdRelatedPerson.relationship The nature of the relationship Definition The nature of the relationship between a patient and the related person.
We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
CodeableConcept Binding The nature of the relationship between a patient and the related person. UKCorePersonRelationshipType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5:FiveWs.class
- v2:NK1-3
- rim:code
|
| name | Σ | 0..* | HumanName | There are no (further) constraints on this element Element IdShort description A name associated with the person Definition A name associated with the person.
Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
HumanName Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:XPN
- rim:EN (actually, PN)
- servd:ProviderName
- v2:NK1-2
- rim:name
|
| telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdShort description A contact detail for the person Definition A contact detail for the person, e.g. a telephone number or an email address.
People have (primary) ways to contact them in some way such as phone, email.
Person 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.
ContactPoint Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - cpt-2:A system is required if a value is provided.
value.empty() or system.exists()
- rim:n/a
- v2:XTN
- rim:TEL
- servd:ContactPoint
- v2:NK1-5 / NK1-6 / NK1-40
- rim:telecom
|
| system | Σ I | 0..1 | codeBinding | There are no (further) constraints on this element Element IdRelatedPerson.telecom.system phone | fax | email | pager | url | sms | other Definition Telecommunications form for contact point - what communications system is required to make use of the contact.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding Telecommunications form for contact point. ContactPointSystem (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:XTN.3
- rim:./scheme
- servd:./ContactPointType
|
| extension | I | 0..* | Extension | Element IdRelatedPerson.telecom.system.extension Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, 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 | I | 0..1 | Extension(Coding) | Element IdRelatedPerson.telecom.system.extension:otherContactSystem Other contact system Alternate names extensions, user content Definition Other contact system value which extends the system element in the ContactPoint datatype.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension(Coding) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem 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()
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdRelatedPerson.telecom.value The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Need to support legacy numbers that are not in a tightly controlled format.
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:XTN.1 (or XTN.12)
- rim:./url
- servd:./Value
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdRelatedPerson.telecom.use home | work | temp | old | mobile - purpose of this contact point Definition Identifies the purpose for the contact point.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
code Binding Use of contact point. ContactPointUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- 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 IdRelatedPerson.telecom.rank Specify preferred order of use (1 = highest) Definition Specifies 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.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
positiveInt Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdRelatedPerson.telecom.period Time period when the contact point was/is in use Definition Time period when the contact point was/is in use.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:N/A
- rim:./usablePeriod[type="IVL<TS>"]
- servd:./StartDate and ./EndDate
|
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdShort description male | female | other | unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Needed for identification of the person, in combination with (at least) name and birth date.
Note that FHIR strings SHALL NOT exceed 1MB in size
code Binding The 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())
- rim:n/a
- v2:NK1-15
- rim:administrativeGender
|
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element IdShort description The date on which the related person was born Definition The date on which the related person was born.
date Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:player.birthTime
|
| address | Σ | 0..* | Address | There are no (further) constraints on this element Element IdShort description Address where the related person can be contacted or visited Definition Address where the related person can be contacted or visited.
Need to keep track where the related person can be contacted per postal mail or visited.
Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
Address Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:XAD
- rim:AD
- servd:Address
- v2:NK1-4
- rim:addr
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element IdShort description Image of the person Definition Requirements Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.
When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
Attachment Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - att-1:If the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists()
- rim:n/a
- v2:ED/RP
- rim:ED
- v2:OBX-5 - needs a profile
- rim:player[classCode='PSN' and determinerCode='INSTANCE']/desc
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element IdShort description Period of time that this relationship is considered valid Definition The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- w5:FiveWs.done[x]
- rim:.effectiveTime
|
| communication | | 0..* | BackboneElement | There are no (further) constraints on this element Element IdRelatedPerson.communication A language which may be used to communicate with about the patient's health Definition A language which may be used to communicate with about the patient's health.
If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- rim:LanguageCommunication
|
| language | | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdRelatedPerson.communication.language The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
CodeableConcept Binding A human language. CommonLanguages (preferred)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
|
| preferred | | 0..1 | boolean | There are no (further) constraints on this element Element IdRelatedPerson.communication.preferred Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.
This language is specifically identified for communicating healthcare information.
boolean Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
