visit the hl7 website
Ontario Provincial Consent Override Interface HL7® FHIR® Implementation Guide v1.0.0-draft1
fhir-logo
  • Index
  • Home
    • Home
    • Introduction
    • Relationship to Other Specifications
    • Scope
    • Glossary
  • Business Context
    • Business Context
    • Business Model
    • Business Data
    • Use Cases
    • Business Rules
  • Technical Context
    • Technical Context
    • Implementer Responsibility
    • Conformance Rules
    • Connectivity Summary
  • FHIR Artifacts
    • FHIR Artifacts
    • Interactions
    • Profiles
    • Extensions
    • Terminology
    • System URIs
    • Examples
    • Capability Statement
    • Response Handling
    • Downloads
  • Change Log
    • Change Log
    • Known Issues & Future Developments
    • Revision History
    1. Index
    2. FHIR Artifacts
    3. Profiles
    4. Profile: RelatedPerson

For a full list of available versions, see the Directory of published versions

4.2.4. Profile: RelatedPerson

This profile is used to capture the Substitute Decision Maker of the patient who is subject to the Consent Block.

Simplifier project page: RelatedPerson

Derived From: RelatedPerson

Canonical_Url Profile_Status Profile_Version FHIR_Version


4.2.4.1. Usage

The RelatedPerson Resource is used to capture information about the Substitute Decision Maker, when the Consent Override is enacted by express consent of the Substitute Decision Maker, where allowed by Ontario Law.


4.2.4.2. Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

RelatedPersonCRelatedPerson
There are no (further) constraints on this element
Element id
RelatedPerson
Short 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.

Data type

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()
Mappings
  • rim: Entity. Role, or Act
  • rim: role
idΣ0..1id
There are no (further) constraints on this element
Element id
RelatedPerson.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
metaS Σ1..1Meta
There are no (further) constraints on this element
Element id
RelatedPerson.meta
Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.meta.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.meta.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
versionIdΣ0..1id
There are no (further) constraints on this element
Element id
RelatedPerson.meta.versionId
Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
lastUpdatedΣ0..1instant
There are no (further) constraints on this element
Element id
RelatedPerson.meta.lastUpdated
Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
sourceΣ0..1uri
There are no (further) constraints on this element
Element id
RelatedPerson.meta.source
Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
profileS Σ1..*canonical(StructureDefinition)Element id
RelatedPerson.meta.profile
Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

For PCOI Usage: meta.profile="http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-RelatedPerson|1.0.0"

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
securityΣ0..*CodingBinding
There are no (further) constraints on this element
Element id
RelatedPerson.meta.security
Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
tagΣ0..*Coding
There are no (further) constraints on this element
Element id
RelatedPerson.meta.tag
Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
RelatedPerson.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
language0..1codeBinding
There are no (further) constraints on this element
Element id
RelatedPerson.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
text0..1Narrative
There are no (further) constraints on this element
Element id
RelatedPerson.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
RelatedPerson.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These 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.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.extension
Short 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
RelatedPerson.identifier
Short description

A human identifier for this person

Definition

Identifier for a person within a particular scope.

Requirements

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.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
activeΣ ?!0..1boolean
There are no (further) constraints on this element
Element id
RelatedPerson.active
Short description

Whether this related person's record is in active use

Definition

Whether this related person record is in active use.

Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: .statusCode
patientS Σ C1..1Reference(Patient)Element id
RelatedPerson.patient
Short description

The patient this person is related to

Definition

The patient this person is related to.

Requirements

We need to know which patient this RelatedPerson is related to.

Comments

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.

Data type

Reference(Patient)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.patient.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.patient.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
referenceS Σ C1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.patient.reference
Short description

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.

Comments

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.

Data type

string

Conditions

The 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() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
RelatedPerson.patient.type
Short description

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).

Comments

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.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
identifierΣ0..1Identifier
There are no (further) constraints on this element
Element id
RelatedPerson.patient.identifier
Short description

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.

Comments

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).

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
displayΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.patient.display
Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
relationshipΣ0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id
RelatedPerson.relationship
Short description

The nature of the relationship

Definition

The nature of the relationship between a patient and the related person.

Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Comments

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.

Data type

CodeableConcept

Binding

The nature of the relationship between a patient and the related person.

PatientRelationshipType (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • v2: NK1-3
  • rim: code
nameS Σ1..1HumanName
There are no (further) constraints on this element
Element id
RelatedPerson.name
Short description

A name associated with the person

Definition

A name associated with the person.

Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Comments

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.

Data type

HumanName

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
  • v2: NK1-2
  • rim: name
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.name.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.name.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
useΣ ?!0..1codeBindingElement id
RelatedPerson.name.use
Short description

usual | official | temp | nickname | anonymous | old | maiden

Definition

Identifies the purpose for this name.

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of a human name.

NameUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.7, but often indicated by which field contains the name
  • rim: unique(./use)
  • servd: ./NamePurpose
textΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.text
Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: implied by XPN.11
  • rim: ./formatted
familyS Σ1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.family
Short description

Family name (often called 'Surname')

Alternate names

surname

Definition

The 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.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.1/FN.1
  • rim: ./part[partType = FAM]
  • servd: ./FamilyName
givenS Σ1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.given
Short description

Given names (not always 'first'). Includes middle names

Alternate names

first name, middle name

Definition

Given name.

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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 id
RelatedPerson.name.prefix
Short description

Parts that come before the name

Definition

Part 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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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 id
RelatedPerson.name.suffix
Short description

Parts that come after the name

Definition

Part 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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN/4
  • rim: ./part[partType = SFX]
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.name.period
Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
telecomS Σ C0..*ContactPoint
There are no (further) constraints on this element
Element id
RelatedPerson.telecom
Short description

A contact detail for the person

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

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.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemS Σ C0..1codeBindingElement id
RelatedPerson.telecom.system
Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The 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() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
valueS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.value
Short description

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).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
useS Σ ?!0..1codeBindingElement id
RelatedPerson.telecom.use
Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

Use of contact point.

ContactPointUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
rankΣ0..1positiveInt
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.rank
Short description

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.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: n/a
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.period
Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
genderS Σ0..1codeBindingElement id
RelatedPerson.gender
Short description

male | female | other | unknown

Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NK1-15
  • rim: administrativeGender
birthDateS Σ0..1date
There are no (further) constraints on this element
Element id
RelatedPerson.birthDate
Short description

The date on which the related person was born

Definition

The date on which the related person was born.

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: player.birthTime
addressS Σ0..*Address
There are no (further) constraints on this element
Element id
RelatedPerson.address
Short description

Address where the related person can be contacted or visited

Definition

Address where the related person can be contacted or visited.

Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Comments

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).

Data type

Address

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
  • v2: NK1-4
  • rim: addr
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.address.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.address.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
useS Σ ?!0..1codeBindingElement id
RelatedPerson.address.use
Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of an address.

AddressUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
home
Mappings
  • rim: n/a
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
typeS Σ0..1codeBindingElement id
RelatedPerson.address.type
Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
both
Mappings
  • rim: n/a
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
textΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.text
Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 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
lineS Σ0..*string
There are no (further) constraints on this element
Element id
RelatedPerson.address.line
Short description

Street name, number, direction & P.O. Box etc.

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 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)
cityS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.city
Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Erewhon
Mappings
  • rim: n/a
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
districtΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.district
Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Madison
Mappings
  • rim: n/a
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
stateS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.state
Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
postalCodeS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.postalCode
Short description

Postal code for area

Alternate names

Zip

Definition

A postal code designating a region defined by the postal service.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
9132
Mappings
  • rim: n/a
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
countryS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.country
Short description

Country (e.g. can be ISO 3166 2 or 3 letter code)

Definition

Country - a nation as commonly understood or generally accepted.

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.address.period
Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
photoC0..*Attachment
There are no (further) constraints on this element
Element id
RelatedPerson.photo
Short description

Image of the person

Definition

Image of the person.

Requirements

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

Comments

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".

Data type

Attachment

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If 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
periodC0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.period
Short 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.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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"]
  • w5: FiveWs.done[x]
  • rim: .effectiveTime
communication0..*BackboneElement
There are no (further) constraints on this element
Element id
RelatedPerson.communication
Short description

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.

Requirements

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.

Comments

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: LanguageCommunication
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.communication.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.communication.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.communication.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
language1..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
RelatedPerson.communication.language
Short description

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.

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Comments

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.

Data type

CodeableConcept

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
preferred0..1boolean
There are no (further) constraints on this element
Element id
RelatedPerson.communication.preferred
Short description

Language preference indicator

Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Requirements

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.

Comments

This language is specifically identified for communicating healthcare information.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: preferenceInd

Hybrid View

RelatedPersonCRelatedPerson
There are no (further) constraints on this element
Element id
RelatedPerson
Short 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.

Data type

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()
Mappings
  • rim: Entity. Role, or Act
  • rim: role
idΣ0..1id
There are no (further) constraints on this element
Element id
RelatedPerson.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
metaS Σ1..1Meta
There are no (further) constraints on this element
Element id
RelatedPerson.meta
Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.meta.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.meta.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
versionIdΣ0..1id
There are no (further) constraints on this element
Element id
RelatedPerson.meta.versionId
Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
lastUpdatedΣ0..1instant
There are no (further) constraints on this element
Element id
RelatedPerson.meta.lastUpdated
Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
sourceΣ0..1uri
There are no (further) constraints on this element
Element id
RelatedPerson.meta.source
Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
profileS Σ1..*canonical(StructureDefinition)Element id
RelatedPerson.meta.profile
Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

For PCOI Usage: meta.profile="http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-RelatedPerson|1.0.0"

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
securityΣ0..*CodingBinding
There are no (further) constraints on this element
Element id
RelatedPerson.meta.security
Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
tagΣ0..*Coding
There are no (further) constraints on this element
Element id
RelatedPerson.meta.tag
Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
RelatedPerson.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
language0..1codeBinding
There are no (further) constraints on this element
Element id
RelatedPerson.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
text0..1Narrative
There are no (further) constraints on this element
Element id
RelatedPerson.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
RelatedPerson.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These 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.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.extension
Short 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
RelatedPerson.identifier
Short description

A human identifier for this person

Definition

Identifier for a person within a particular scope.

Requirements

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.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
activeΣ ?!0..1boolean
There are no (further) constraints on this element
Element id
RelatedPerson.active
Short description

Whether this related person's record is in active use

Definition

Whether this related person record is in active use.

Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: .statusCode
patientS Σ C1..1Reference(Patient)Element id
RelatedPerson.patient
Short description

The patient this person is related to

Definition

The patient this person is related to.

Requirements

We need to know which patient this RelatedPerson is related to.

Comments

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.

Data type

Reference(Patient)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.patient.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.patient.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
referenceS Σ C1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.patient.reference
Short description

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.

Comments

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.

Data type

string

Conditions

The 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() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
RelatedPerson.patient.type
Short description

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).

Comments

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.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
identifierΣ0..1Identifier
There are no (further) constraints on this element
Element id
RelatedPerson.patient.identifier
Short description

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.

Comments

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).

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
displayΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.patient.display
Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
relationshipΣ0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id
RelatedPerson.relationship
Short description

The nature of the relationship

Definition

The nature of the relationship between a patient and the related person.

Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Comments

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.

Data type

CodeableConcept

Binding

The nature of the relationship between a patient and the related person.

PatientRelationshipType (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • v2: NK1-3
  • rim: code
nameS Σ1..1HumanName
There are no (further) constraints on this element
Element id
RelatedPerson.name
Short description

A name associated with the person

Definition

A name associated with the person.

Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Comments

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.

Data type

HumanName

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
  • v2: NK1-2
  • rim: name
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.name.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.name.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
useΣ ?!0..1codeBindingElement id
RelatedPerson.name.use
Short description

usual | official | temp | nickname | anonymous | old | maiden

Definition

Identifies the purpose for this name.

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of a human name.

NameUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.7, but often indicated by which field contains the name
  • rim: unique(./use)
  • servd: ./NamePurpose
textΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.text
Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: implied by XPN.11
  • rim: ./formatted
familyS Σ1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.family
Short description

Family name (often called 'Surname')

Alternate names

surname

Definition

The 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.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.1/FN.1
  • rim: ./part[partType = FAM]
  • servd: ./FamilyName
givenS Σ1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.given
Short description

Given names (not always 'first'). Includes middle names

Alternate names

first name, middle name

Definition

Given name.

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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 id
RelatedPerson.name.prefix
Short description

Parts that come before the name

Definition

Part 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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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 id
RelatedPerson.name.suffix
Short description

Parts that come after the name

Definition

Part 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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN/4
  • rim: ./part[partType = SFX]
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.name.period
Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
telecomS Σ C0..*ContactPoint
There are no (further) constraints on this element
Element id
RelatedPerson.telecom
Short description

A contact detail for the person

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

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.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemS Σ C0..1codeBindingElement id
RelatedPerson.telecom.system
Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The 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() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
valueS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.value
Short description

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).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
useS Σ ?!0..1codeBindingElement id
RelatedPerson.telecom.use
Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

Use of contact point.

ContactPointUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
rankΣ0..1positiveInt
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.rank
Short description

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.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: n/a
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.period
Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
genderS Σ0..1codeBindingElement id
RelatedPerson.gender
Short description

male | female | other | unknown

Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NK1-15
  • rim: administrativeGender
birthDateS Σ0..1date
There are no (further) constraints on this element
Element id
RelatedPerson.birthDate
Short description

The date on which the related person was born

Definition

The date on which the related person was born.

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: player.birthTime
addressS Σ0..*Address
There are no (further) constraints on this element
Element id
RelatedPerson.address
Short description

Address where the related person can be contacted or visited

Definition

Address where the related person can be contacted or visited.

Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Comments

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).

Data type

Address

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
  • v2: NK1-4
  • rim: addr
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.address.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.address.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
useS Σ ?!0..1codeBindingElement id
RelatedPerson.address.use
Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of an address.

AddressUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
home
Mappings
  • rim: n/a
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
typeS Σ0..1codeBindingElement id
RelatedPerson.address.type
Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
both
Mappings
  • rim: n/a
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
textΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.text
Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 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
lineS Σ0..*string
There are no (further) constraints on this element
Element id
RelatedPerson.address.line
Short description

Street name, number, direction & P.O. Box etc.

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 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)
cityS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.city
Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Erewhon
Mappings
  • rim: n/a
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
districtΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.district
Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Madison
Mappings
  • rim: n/a
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
stateS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.state
Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
postalCodeS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.postalCode
Short description

Postal code for area

Alternate names

Zip

Definition

A postal code designating a region defined by the postal service.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
9132
Mappings
  • rim: n/a
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
countryS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.country
Short description

Country (e.g. can be ISO 3166 2 or 3 letter code)

Definition

Country - a nation as commonly understood or generally accepted.

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.address.period
Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
photoC0..*Attachment
There are no (further) constraints on this element
Element id
RelatedPerson.photo
Short description

Image of the person

Definition

Image of the person.

Requirements

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

Comments

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".

Data type

Attachment

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If 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
periodC0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.period
Short 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.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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"]
  • w5: FiveWs.done[x]
  • rim: .effectiveTime
communication0..*BackboneElement
There are no (further) constraints on this element
Element id
RelatedPerson.communication
Short description

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.

Requirements

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.

Comments

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: LanguageCommunication
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.communication.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.communication.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.communication.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
language1..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
RelatedPerson.communication.language
Short description

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.

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Comments

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.

Data type

CodeableConcept

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
preferred0..1boolean
There are no (further) constraints on this element
Element id
RelatedPerson.communication.preferred
Short description

Language preference indicator

Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Requirements

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.

Comments

This language is specifically identified for communicating healthcare information.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: preferenceInd

Snapshot View

RelatedPersonCRelatedPerson
There are no (further) constraints on this element
Element id
RelatedPerson
Short 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.

Data type

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()
Mappings
  • rim: Entity. Role, or Act
  • rim: role
idΣ0..1id
There are no (further) constraints on this element
Element id
RelatedPerson.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
metaS Σ1..1Meta
There are no (further) constraints on this element
Element id
RelatedPerson.meta
Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.meta.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.meta.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
versionIdΣ0..1id
There are no (further) constraints on this element
Element id
RelatedPerson.meta.versionId
Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
lastUpdatedΣ0..1instant
There are no (further) constraints on this element
Element id
RelatedPerson.meta.lastUpdated
Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
sourceΣ0..1uri
There are no (further) constraints on this element
Element id
RelatedPerson.meta.source
Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
profileS Σ1..*canonical(StructureDefinition)Element id
RelatedPerson.meta.profile
Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

For PCOI Usage: meta.profile="http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-RelatedPerson|1.0.0"

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
securityΣ0..*CodingBinding
There are no (further) constraints on this element
Element id
RelatedPerson.meta.security
Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
tagΣ0..*Coding
There are no (further) constraints on this element
Element id
RelatedPerson.meta.tag
Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
RelatedPerson.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
language0..1codeBinding
There are no (further) constraints on this element
Element id
RelatedPerson.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
text0..1Narrative
There are no (further) constraints on this element
Element id
RelatedPerson.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
RelatedPerson.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These 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.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.extension
Short 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
RelatedPerson.identifier
Short description

A human identifier for this person

Definition

Identifier for a person within a particular scope.

Requirements

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.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
activeΣ ?!0..1boolean
There are no (further) constraints on this element
Element id
RelatedPerson.active
Short description

Whether this related person's record is in active use

Definition

Whether this related person record is in active use.

Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: .statusCode
patientS Σ C1..1Reference(Patient)Element id
RelatedPerson.patient
Short description

The patient this person is related to

Definition

The patient this person is related to.

Requirements

We need to know which patient this RelatedPerson is related to.

Comments

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.

Data type

Reference(Patient)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.patient.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.patient.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
referenceS Σ C1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.patient.reference
Short description

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.

Comments

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.

Data type

string

Conditions

The 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() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
RelatedPerson.patient.type
Short description

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).

Comments

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.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
identifierΣ0..1Identifier
There are no (further) constraints on this element
Element id
RelatedPerson.patient.identifier
Short description

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.

Comments

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).

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
displayΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.patient.display
Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
relationshipΣ0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id
RelatedPerson.relationship
Short description

The nature of the relationship

Definition

The nature of the relationship between a patient and the related person.

Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Comments

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.

Data type

CodeableConcept

Binding

The nature of the relationship between a patient and the related person.

PatientRelationshipType (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • v2: NK1-3
  • rim: code
nameS Σ1..1HumanName
There are no (further) constraints on this element
Element id
RelatedPerson.name
Short description

A name associated with the person

Definition

A name associated with the person.

Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Comments

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.

Data type

HumanName

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
  • v2: NK1-2
  • rim: name
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.name.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.name.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
useΣ ?!0..1codeBindingElement id
RelatedPerson.name.use
Short description

usual | official | temp | nickname | anonymous | old | maiden

Definition

Identifies the purpose for this name.

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of a human name.

NameUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.7, but often indicated by which field contains the name
  • rim: unique(./use)
  • servd: ./NamePurpose
textΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.text
Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: implied by XPN.11
  • rim: ./formatted
familyS Σ1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.family
Short description

Family name (often called 'Surname')

Alternate names

surname

Definition

The 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.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN.1/FN.1
  • rim: ./part[partType = FAM]
  • servd: ./FamilyName
givenS Σ1..1string
There are no (further) constraints on this element
Element id
RelatedPerson.name.given
Short description

Given names (not always 'first'). Includes middle names

Alternate names

first name, middle name

Definition

Given name.

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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 id
RelatedPerson.name.prefix
Short description

Parts that come before the name

Definition

Part 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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
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 id
RelatedPerson.name.suffix
Short description

Parts that come after the name

Definition

Part 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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN/4
  • rim: ./part[partType = SFX]
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.name.period
Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
telecomS Σ C0..*ContactPoint
There are no (further) constraints on this element
Element id
RelatedPerson.telecom
Short description

A contact detail for the person

Definition

A contact detail for the person, e.g. a telephone number or an email address.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

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.

Data type

ContactPoint

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemS Σ C0..1codeBindingElement id
RelatedPerson.telecom.system
Short description

phone | fax | email | pager | url | sms | other

Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The 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() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
valueS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.value
Short description

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).

Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
useS Σ ?!0..1codeBindingElement id
RelatedPerson.telecom.use
Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

Use of contact point.

ContactPointUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
rankΣ0..1positiveInt
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.rank
Short description

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.

Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Data type

positiveInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: n/a
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.telecom.period
Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
genderS Σ0..1codeBindingElement id
RelatedPerson.gender
Short description

male | female | other | unknown

Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NK1-15
  • rim: administrativeGender
birthDateS Σ0..1date
There are no (further) constraints on this element
Element id
RelatedPerson.birthDate
Short description

The date on which the related person was born

Definition

The date on which the related person was born.

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: player.birthTime
addressS Σ0..*Address
There are no (further) constraints on this element
Element id
RelatedPerson.address
Short description

Address where the related person can be contacted or visited

Definition

Address where the related person can be contacted or visited.

Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Comments

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).

Data type

Address

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
  • v2: NK1-4
  • rim: addr
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.address.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.address.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
useS Σ ?!0..1codeBindingElement id
RelatedPerson.address.use
Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of an address.

AddressUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
home
Mappings
  • rim: n/a
  • v2: XAD.7
  • rim: unique(./use)
  • servd: ./AddressPurpose
typeS Σ0..1codeBindingElement id
RelatedPerson.address.type
Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

code

Binding

The type of an address (physical / postal).

AddressType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
both
Mappings
  • rim: n/a
  • v2: XAD.18
  • rim: unique(./use)
  • vcard: address type parameter
textΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.text
Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 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
lineS Σ0..*string
There are no (further) constraints on this element
Element id
RelatedPerson.address.line
Short description

Street name, number, direction & P.O. Box etc.

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 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)
cityS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.city
Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Erewhon
Mappings
  • rim: n/a
  • v2: XAD.3
  • rim: AD.part[parttype = CTY]
  • vcard: locality
  • servd: ./Jurisdiction
districtΣ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.district
Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Madison
Mappings
  • rim: n/a
  • v2: XAD.9
  • rim: AD.part[parttype = CNT | CPA]
stateS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.state
Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.4
  • rim: AD.part[parttype = STA]
  • vcard: region
  • servd: ./Region
postalCodeS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.postalCode
Short description

Postal code for area

Alternate names

Zip

Definition

A postal code designating a region defined by the postal service.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
9132
Mappings
  • rim: n/a
  • v2: XAD.5
  • rim: AD.part[parttype = ZIP]
  • vcard: code
  • servd: ./PostalIdentificationCode
countryS Σ0..1string
There are no (further) constraints on this element
Element id
RelatedPerson.address.country
Short description

Country (e.g. can be ISO 3166 2 or 3 letter code)

Definition

Country - a nation as commonly understood or generally accepted.

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD.6
  • rim: AD.part[parttype = CNT]
  • vcard: country
  • servd: ./Country
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.address.period
Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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
photoC0..*Attachment
There are no (further) constraints on this element
Element id
RelatedPerson.photo
Short description

Image of the person

Definition

Image of the person.

Requirements

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

Comments

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".

Data type

Attachment

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If 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
periodC0..1Period
There are no (further) constraints on this element
Element id
RelatedPerson.period
Short 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.

Comments

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.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() 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"]
  • w5: FiveWs.done[x]
  • rim: .effectiveTime
communication0..*BackboneElement
There are no (further) constraints on this element
Element id
RelatedPerson.communication
Short description

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.

Requirements

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.

Comments

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.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: LanguageCommunication
id0..1
There are no (further) constraints on this element
Element id
RelatedPerson.communication.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.communication.extension
Short 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 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.

Comments

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
RelatedPerson.communication.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
language1..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
RelatedPerson.communication.language
Short description

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.

Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Comments

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.

Data type

CodeableConcept

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • 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
preferred0..1boolean
There are no (further) constraints on this element
Element id
RelatedPerson.communication.preferred
Short description

Language preference indicator

Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Requirements

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.

Comments

This language is specifically identified for communicating healthcare information.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: preferenceInd

Table View

RelatedPerson..
RelatedPerson.meta1..
RelatedPerson.meta.profile1..
RelatedPerson.patientReference(Patient)..
RelatedPerson.patient.reference1..
RelatedPerson.name1..1
RelatedPerson.name.use..
RelatedPerson.name.family1..
RelatedPerson.name.given1..1
RelatedPerson.telecom..
RelatedPerson.telecom.system..
RelatedPerson.telecom.value..
RelatedPerson.telecom.use..
RelatedPerson.gender..
RelatedPerson.birthDate..
RelatedPerson.address..
RelatedPerson.address.use..
RelatedPerson.address.type..
RelatedPerson.address.line..
RelatedPerson.address.city..
RelatedPerson.address.state..
RelatedPerson.address.postalCode..
RelatedPerson.address.country..

JSON View

{
"resourceType": "StructureDefinition",
"meta": {
"lastUpdated": "2024-09-25T13:51:31.3065704+00:00"
},
"url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-RelatedPerson",
"version": "1.0.0",
"name": "RelatedPerson",
"status": "draft",
"date": "2024-04-30T16:08:02.1275853+00:00",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "RelatedPerson",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "RelatedPerson.meta",
"path": "RelatedPerson.meta",
"min": 1,
"mustSupport": true
},
{
"id": "RelatedPerson.meta.profile",
"path": "RelatedPerson.meta.profile",
"comment": "For PCOI Usage: meta.profile=\"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-RelatedPerson|1.0.0\"\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 1,
"mustSupport": true
},
{
"id": "RelatedPerson.patient",
"path": "RelatedPerson.patient",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Patient"
]
}
],
"mustSupport": true
},
{
"id": "RelatedPerson.patient.reference",
"path": "RelatedPerson.patient.reference",
"min": 1,
"mustSupport": true
},
{
"id": "RelatedPerson.name",
"path": "RelatedPerson.name",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "RelatedPerson.name.use",
"path": "RelatedPerson.name.use",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use"
}
},
{
"id": "RelatedPerson.name.family",
"path": "RelatedPerson.name.family",
"min": 1,
"mustSupport": true
},
{
"id": "RelatedPerson.name.given",
"path": "RelatedPerson.name.given",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "RelatedPerson.telecom",
"path": "RelatedPerson.telecom",
"mustSupport": true
},
{
"id": "RelatedPerson.telecom.system",
"path": "RelatedPerson.telecom.system",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
{
"id": "RelatedPerson.telecom.value",
"path": "RelatedPerson.telecom.value",
"mustSupport": true
},
{
"id": "RelatedPerson.telecom.use",
"path": "RelatedPerson.telecom.use",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
{
"id": "RelatedPerson.gender",
"path": "RelatedPerson.gender",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"id": "RelatedPerson.birthDate",
"path": "RelatedPerson.birthDate",
"mustSupport": true
},
{
"id": "RelatedPerson.address",
"path": "RelatedPerson.address",
"mustSupport": true
},
{
"id": "RelatedPerson.address.use",
"path": "RelatedPerson.address.use",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-use"
}
},
{
"id": "RelatedPerson.address.type",
"path": "RelatedPerson.address.type",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-type"
}
},
{
"id": "RelatedPerson.address.line",
"path": "RelatedPerson.address.line",
"mustSupport": true
},
{
"id": "RelatedPerson.address.city",
"path": "RelatedPerson.address.city",
"mustSupport": true
},
{
"id": "RelatedPerson.address.state",
"path": "RelatedPerson.address.state",
"mustSupport": true
},
{
"id": "RelatedPerson.address.postalCode",
"path": "RelatedPerson.address.postalCode",
"mustSupport": true
},
{
"id": "RelatedPerson.address.country",
"path": "RelatedPerson.address.country",
"mustSupport": true
}
]
}
}


4.2.4.3. Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing the Consent reques, a UUID SHOULD be used in this element

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-RelatedPerson

.patient

  • populate with the patient.id of the contained Patient resource

.relationship

  • populate with the RelatedPerson's relationship to the patient

.name

  • the .name of the RelatedPerson SHALL be provided

.telecom

  • SHOULD contain a telephone number

.gender

  • SHALL contain the RelatedPerson's gender for administrative purposes

.birthDate

  • SHALL contain the RelatedPerson's birthday

.address

  • SHOULD contain an address

4.2.4.4. Terminology Bindings

PathConformanceValueSet
RelatedPerson.telecom.systemrequiredhttp://hl7.org/fhir/ValueSet/contact-point-system
RelatedPerson.telecom.userequiredhttp://hl7.org/fhir/ValueSet/contact-point-use
RelatedPerson.genderrequiredhttp://hl7.org/fhir/ValueSet/administrative-gender
RelatedPerson.address.userequiredhttp://hl7.org/fhir/ValueSet/address-use
RelatedPerson.address.typerequiredhttp://hl7.org/fhir/ValueSet/address-type

Version: 1.0.0 FHIR Version: R4.0.1

Powered by SIMPLIFIER.NET

HL7® and FHIR® are the registered trademarks of Health Level Seven International