| DCH-RelatedPerson-1 (RelatedPerson) | C | | RelatedPerson | There are no (further) constraints on this element Element idRelatedPerson Short descriptionAn person that is related to a patient, but who is not a direct target of care DefinitionInformation 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-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.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
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
Mappings- rim: Entity. Role, or Act
- rim: role
- w5: administrative.individual
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idRelatedPerson.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.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
id 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() | (children().count() > id.count())
Mappings |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.meta Short descriptionMetadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Meta 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() | (children().count() > id.count())
Mappings |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.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.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
uri 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() | (children().count() > id.count())
Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
code BindingA human language. Common Languages (extensible) Binding extensionsConditionsThe 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() | (children().count() > id.count())
Mappings |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.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 may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Narrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.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.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| householdMember | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idRelatedPerson.extension:householdMember Short descriptionThe household member information for a person related to the Patient Alternate namesextensions, user content DefinitionThe household member information for a person related to the Patient
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 URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-DCH-HouseholdMember-1 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| link | C | 0..1 | Extension(Reference(CareConnect-DCH-Patient-1)) | There are no (further) constraints on this element Element idRelatedPerson.extension:link Short descriptionLink to a Patient resource for a Related Person Alternate namesextensions, user content DefinitionLink to a Patient resource for a 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(Reference(CareConnect-DCH-Patient-1)) Extension URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-DCH-Link-1 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| parentalResponsibility | C | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element idRelatedPerson.extension:parentalResponsibility Short descriptionWhether the related or significant person has parental responsibility Alternate namesextensions, user content DefinitionWhether the related or significant person has parental responsibility
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 URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-DCH-ParentalResponsibility-1 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| significantIndividual | C | 0..* | Extension(boolean) | There are no (further) constraints on this element Element idRelatedPerson.extension:significantIndividual Short descriptionWhether an individual related to the child is deemed as key by family Alternate namesextensions, user content DefinitionWhether an individual related to the child is deemed as key by family
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 URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-DCH-SignificantIndividual-1 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() | (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 idRelatedPerson.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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRelatedPerson.identifier Short descriptionA human identifier for this person DefinitionIdentifier 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 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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
- v2: NK1-33
- rim: .id
- w5: id
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.use Short descriptionusual | official | temp | secondary (If known) DefinitionThe purpose of this identifier.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
code BindingIdentifies the purpose for this identifier, if known . IdentifierUse (required) 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: N/A
- rim: Role.code or implied by context
|
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.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.
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 BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) 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() | (children().count() > id.count())
Mappings- 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 | Σ | 1..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.identifier.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.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
uri 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() | (children().count() > id.count())
Examples
Generalhttp://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Mappings- rim: n/a
- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.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.
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.
string 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() | (children().count() > id.count())
Examples
General123456 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 | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier.period Short descriptionTime period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Period 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() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)
Mappings- 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 | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idRelatedPerson.identifier.assigner Short descriptionOrganization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Reference(Organization) 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() | (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 %resource.contained.id.trace('ids'))
Mappings- 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..0 | boolean | There are no (further) constraints on this element Element idRelatedPerson.active Short descriptionWhether this related person's record is in active use DefinitionWhether 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 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() | (children().count() > id.count())
Default valuetrue Mappings- rim: n/a
- rim: .statusCode
- w5: status
|
| patient | Σ C | 1..1 | Reference(CareConnect-DCH-Patient-1) | There are no (further) constraints on this element Element idRelatedPerson.patient Short descriptionThe patient this person is related to DefinitionThe 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(CareConnect-DCH-Patient-1) 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() | (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 %resource.contained.id.trace('ids'))
Mappings- 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
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.patient.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.patient.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| reference | Σ C | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.patient.reference Short descriptionLiteral reference, Relative, internal or absolute URL DefinitionA 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings |
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRelatedPerson.patient.identifier Short descriptionLogical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.
Identifier 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.patient.display Short descriptionText alternative for the resource DefinitionPlain 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 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() | (children().count() > id.count())
Mappings |
| relationship | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationship Short descriptionThe nature of the relationship DefinitionThe 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 BindingThe nature of the relationship between a patient and the related person DCH Person Relationship Type (extensible) 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: NK1-3
- rim: code
- w5: class
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Coding 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
uri 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding.version Short descriptionVersion of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding.code Short descriptionSymbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Need to refer to a particular code in the system.
Note that FHIR strings may not exceed 1MB in size
code 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding.userSelected Short descriptionIf this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
boolean 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.text Short descriptionPlain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Very often the text is the same as a displayName of one of the codings.
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| name | Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idRelatedPerson.name Short descriptionA name associated with the person DefinitionA 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 may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
HumanName 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN
- rim: EN (actually, PN)
- servd: ProviderName
- v2: NK1-2
- rim: name
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (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 idRelatedPerson.name.use Short descriptionusual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name.
Allows the appropriate name for a particular context of use to be selected from among a set of names.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.
code BindingThe use of a human name NameUse (required) 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() | (children().count() > id.count())
Mappings- rim: n/a
- 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 idRelatedPerson.name.text Short descriptionText representation of the full name DefinitionA full text representation of the name.
A renderable, unencoded form.
Can provide both a text representation and structured parts.
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: implied by XPN.11
- rim: ./formatted
|
| family | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.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.
Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN.1/FN.1
- rim: ./part[partType = FAM]
- servd: ./FamilyName
|
| given | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.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. Not called "first name" since given names do not always come first.
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN.2 + XPN.3
- rim: ./part[partType = GIV]
- servd: ./GivenNames
|
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.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.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN.5
- rim: ./part[partType = PFX]
- servd: ./TitleCode
|
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.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.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XPN/4
- rim: ./part[partType = SFX]
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.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.
Allows names to be placed in historical context.
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Period 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() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XPN.13 + XPN.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name.period.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.name.period.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idRelatedPerson.name.period.start Short descriptionStarting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive.
If the low element is missing, the meaning is that the low boundary is not known.
dateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: DR.1
- rim: ./low
|
| end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idRelatedPerson.name.period.end Short descriptionEnd time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
dateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: DR.2
- rim: ./high
|
| telecom | Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idRelatedPerson.telecom Short descriptionA contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address.
People have (primary) ways to contact them in some way such as phone, email.
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 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() | (children().count() > id.count()) - cpt-2: A system is required if a value is provided.
value.empty() or system.exists()
Mappings- rim: n/a
- v2: XTN
- rim: TEL
- servd: ContactPoint
- v2: NK1-5 / NK1-6 / NK1-40
- rim: telecom
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.telecom.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (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 idRelatedPerson.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.
Note that FHIR strings may not exceed 1MB in size
code BindingTelecommunications form for contact point ContactPointSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XTN.3
- rim: ./scheme
- servd: ./ContactPointType
|
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.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).
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 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() | (children().count() > id.count())
Mappings- 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 Short descriptionhome | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
code BindingUse of contact point ContactPointUse (required) 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() | (children().count() > id.count())
Mappings- 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 Short descriptionSpecify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
positiveInt 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() | (children().count() > id.count())
Mappings |
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.telecom.period Short descriptionTime period when the contact point was/is in use DefinitionTime period when the contact point was/is in use.
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Period 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() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)
Mappings- 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
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.telecom.period.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.telecom.period.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idRelatedPerson.telecom.period.start Short descriptionStarting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive.
If the low element is missing, the meaning is that the low boundary is not known.
dateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: DR.1
- rim: ./low
|
| end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idRelatedPerson.telecom.period.end Short descriptionEnd time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
dateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: DR.2
- rim: ./high
|
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.gender Short descriptionmale | female | other | unknown DefinitionAdministrative 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 may not exceed 1MB in size
code BindingThe gender of a person used for administrative purposes. Administrative Gender (required) 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: NK1-15
- rim: administrativeGender
|
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDate Short descriptionThe date on which the related person was born DefinitionThe date on which the related person was born.
date 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() | (children().count() > id.count())
Mappings- rim: n/a
- rim: player.birthTime
|
| address | Σ | 0..* | Address | There are no (further) constraints on this element Element idRelatedPerson.address Short descriptionAddress where the related person can be contacted or visited DefinitionAddress 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 for postal addresses, not physical locations.
Address 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD
- rim: AD
- servd: Address
- v2: NK1-4
- rim: addr
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (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 idRelatedPerson.address.use Short descriptionhome | work | temp | old - purpose of this address DefinitionThe purpose of this address.
Allows an appropriate address to be chosen from a list of many.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.
code BindingThe use of an address AddressUse (required) 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() | (children().count() > id.count())
Examples
Generalhome Mappings- rim: n/a
- v2: XAD.7
- rim: unique(./use)
- servd: ./AddressPurpose
|
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.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.
Note that FHIR strings may not exceed 1MB in size
code BindingThe type of an address (physical / postal) AddressType (required) 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() | (children().count() > id.count())
Examples
Generalboth Mappings- rim: n/a
- v2: XAD.18
- rim: unique(./use)
- vcard: address type parameter
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address.text Short descriptionText representation of the address DefinitionA full text representation of the address.
A renderable, unencoded form.
Can provide both a text representation and parts.
string 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() | (children().count() > id.count())
Examples
General137 Nowhere Street, Erewhon 9132 Mappings- rim: n/a
- v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
- rim: ./formatted
- vcard: address label parameter
|
| line | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.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.
home | work | temp | old - purpose of this address.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Examples
General137 Nowhere Street Mappings- rim: n/a
- 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 | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address.city Short descriptionName of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, village or other community or delivery center.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Examples
GeneralErewhon Mappings- rim: n/a
- 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 idRelatedPerson.address.district Short descriptionDistrict name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county).
District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
string 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() | (children().count() > id.count())
Examples
GeneralMadison Mappings- rim: n/a
- v2: XAD.9
- rim: AD.part[parttype = CNT | CPA]
|
| state | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.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 (i.e. US 2 letter state codes).
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD.4
- rim: AD.part[parttype = STA]
- vcard: region
- servd: ./Region
|
| postalCode | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address.postalCode Short descriptionPostal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Examples
General9132 Mappings- rim: n/a
- 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 idRelatedPerson.address.country Short descriptionCountry (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted.
ISO 3166 3 letter codes can be used in place of a full country name.
string 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() | (children().count() > id.count())
Mappings- rim: n/a
- v2: XAD.6
- rim: AD.part[parttype = CNT]
- vcard: country
- servd: ./Country
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.address.period Short descriptionTime period when address was/is in use DefinitionTime period when address was/is in use.
Allows addresses to be placed in historical context.
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Period 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() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)
Examples
General{
"start": "2010-03-23",
"end": "2010-07-01"
}Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: XAD.12 / XAD.13 + XAD.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.address.period.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Note that FHIR strings may not exceed 1MB in size
string 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() | (children().count() > id.count())
Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.address.period.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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url 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() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idRelatedPerson.address.period.start Short descriptionStarting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive.
If the low element is missing, the meaning is that the low boundary is not known.
dateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: DR.1
- rim: ./low
|
| end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idRelatedPerson.address.period.end Short descriptionEnd time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
dateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, per-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings- rim: n/a
- v2: DR.2
- rim: ./high
|
| photo | C | 0..0 | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photo Short descriptionImage of the person DefinitionRequirementsMany 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 "Attachment".
Attachment 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() | (children().count() > id.count()) - att-1: It the Attachment has data, it SHALL have a contentType
data.empty() or contentType.exists()
Mappings- rim: n/a
- v2: ED/RP
- rim: ED
- v2: OBX-5 - needs a profile
- rim: player[classCode='PSN' and determinerCode='INSTANCE']/desc
|
| period | C | 0..0 | Period | There are no (further) constraints on this element Element idRelatedPerson.period Short descriptionPeriod of time that this relationship is considered valid DefinitionThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Period 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() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)
Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- rim: .effectiveTime
- w5: when.done
|
