CH EMED EPR
1.0.1-ci-build - ci-build Switzerland flag

CH EMED EPR, published by CARA. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CARA-ch/ch-emed-epr/ and changes regularly. See the Directory of published versions

Resource Profile: CHEMEDEPRRelatedPerson - Detailed Descriptions

Draft as of 2024-04-05

Definitions for the ch-emed-epr-related-person resource profile.

Guidance on how to interpret the contents of this table can be found here

0. RelatedPerson
2. RelatedPerson.meta
4. RelatedPerson.meta.extension
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
6. RelatedPerson.meta.versionId
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
8. RelatedPerson.meta.lastUpdated
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
10. RelatedPerson.meta.source
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
12. RelatedPerson.meta.security
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
14. RelatedPerson.meta.tag
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
16. RelatedPerson.implicitRules
Comments

...All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
18. RelatedPerson.modifierExtension
Comments

...All modifiers SHALL be documented in the profile, in order to be usable.

Control0..0
20. RelatedPerson.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
22. RelatedPerson.identifier.extension
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
24. RelatedPerson.identifier.type
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
26. RelatedPerson.identifier.period
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
28. RelatedPerson.identifier.assigner
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element will be removed in PML(C) documents
Comments

✕ Unsupported reference. It'll be stripped when generating PML(C) documents.

TypeReference(CH EMED EPR Organization)
Standards StatusDraft (from Trial Use)
30. RelatedPerson.active
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)
32. RelatedPerson.period
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Standards StatusDraft (from Trial Use)

Guidance on how to interpret the contents of this table can be found here

0. RelatedPerson
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.

ShortA person that is related to a patient, but who is not a direct target of care
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. RelatedPerson.implicitRules
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.

ShortA set of rules under which this content was created
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. All modifiers SHALL be documented in the profile, in order to be usable.


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.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. RelatedPerson.modifierExtension
Definition

An Extension


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

ShortExtensionExtensions that cannot be ignored
Comments

All modifiers SHALL be documented in the profile, in order to be usable.


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.

Control0..0*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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.

Alternate Namesextensions, user content
Invariantsele-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())
6. RelatedPerson.active
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


Whether this related person record is in active use.

Short✕ This element is not supportedWhether this related person's record is in active use
Comments

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

Control0..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. RelatedPerson.patient
Definition

The patient this person is related to.

ShortThe patient this person is related to
Control1..1
TypeReference(Patient)
Is Modifierfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. RelatedPerson.period
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.


The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

Short✕ This element is not supportedPeriod of time that this relationship is considered valid
Control0..1
TypePeriod
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. RelatedPerson
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.

ShortA person that is related to a patient, but who is not a direct target of care
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. RelatedPerson.id
Definition

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

ShortLogical id of this artifact
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.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. RelatedPerson.meta
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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. RelatedPerson.meta.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. RelatedPerson.meta.extension
Definition

Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

Short✕ This element is not supported
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on RelatedPerson.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. RelatedPerson.meta.versionId
    Definition

    Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

    Short✕ This element is not supported
    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.

    Control0..1
    Typeid
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. RelatedPerson.meta.lastUpdated
    Definition

    Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

    Short✕ This element is not supported
    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.

    Control0..1
    Typeinstant
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. RelatedPerson.meta.source
    Definition

    Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

    Short✕ This element is not supported
    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.

    Control0..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. RelatedPerson.meta.profile
    Definition

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

    ShortProfiles this resource claims to conform to
    Comments

    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.

    Control0..*
    Typecanonical(StructureDefinition)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. RelatedPerson.meta.security
    Definition

    Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

    Short✕ This element is not supported
    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.

    Control0..*
    BindingUnless not suitable, these codes SHALL be taken from All Security Labels
    (extensible to http://hl7.org/fhir/ValueSet/security-labels)

    Security Labels from the Healthcare Privacy and Security Classification System.

    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. RelatedPerson.meta.tag
    Definition

    Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

    Short✕ This element is not supported
    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.

    Control0..*
    BindingFor example codes, see CommonTags
    (example to http://hl7.org/fhir/ValueSet/common-tags)

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

    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. RelatedPerson.implicitRules
    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.

    ShortA set of rules under which this content was created
    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. All modifiers SHALL be documented in the profile, in order to be usable.

    Control0..0
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. RelatedPerson.language
    Definition

    The base language in which the resource is written.

    ShortLanguage of the resource content
    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).

    Control0..1
    BindingThe codes SHOULD be taken from CommonLanguages
    (preferred to http://hl7.org/fhir/ValueSet/languages)

    A human language.

    Additional BindingsPurpose
    AllLanguagesMax Binding
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. RelatedPerson.text
    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.

    ShortText summary of the resource, for human interpretation
    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.

    Control0..1
    TypeNarrative
    Is Modifierfalse
    Summaryfalse
    Alternate Namesnarrative, html, xhtml, display
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. RelatedPerson.contained
    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.

    ShortContained, inline Resources
    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.

    Control0..*
    TypeResource
    Is Modifierfalse
    Summaryfalse
    Alternate Namesinline resources, anonymous resources, contained resources
    30. RelatedPerson.extension
    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.

    ShortAdditional content defined by implementations
    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    32. RelatedPerson.modifierExtension
    Definition

    An Extension

    ShortExtension
    Comments

    All modifiers SHALL be documented in the profile, in order to be usable.

    Control0..0
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Invariantsele-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())
    34. RelatedPerson.identifier
    Definition

    Identifier for a person within a particular scope.

    ShortA human identifier for this person
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    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.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. RelatedPerson.identifier.id
    Definition

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

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    38. RelatedPerson.identifier.extension
    Definition

    Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

    Short✕ This element is not supported
    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 40. RelatedPerson.identifier.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUse
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. RelatedPerson.identifier.type
      Definition

      Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

      Short✕ This element is not supported
      Comments

      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

      Control0..1
      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
      (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

      A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

      Allows users to make use of identifiers when the identifier system is not known.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. RelatedPerson.identifier.system
      Definition

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      ShortThe namespace for the identifier value
      Comments

      Identifier.system is always case sensitive.

      Control0..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. RelatedPerson.identifier.value
      Definition

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      ShortThe value that is unique
      Comments

      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Example<br/><b>General</b>:123456
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. RelatedPerson.identifier.period
      Definition

      Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

      Short✕ This element is not supported
      Control0..1
      TypePeriod
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. RelatedPerson.identifier.assigner
      Definition

      Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

      Short✕ This element will be removed in PML(C) documents
      Comments

      ✕ Unsupported reference. It'll be stripped when generating PML(C) documents.

      Control0..1
      TypeReference(CH EMED EPR Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. RelatedPerson.active
      Definition

      Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

      Short✕ This element is not supported
      Comments

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

      Control0..1
      Typeboolean
      Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

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

      Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. RelatedPerson.patient
      Definition

      The patient this person is related to.

      ShortThe patient this person is related to
      Control1..1
      TypeReference(Patient)
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. RelatedPerson.relationship
      Definition

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

      ShortThe nature of the relationship
      Control0..*
      BindingThe codes SHOULD be taken from PatientRelationshipType
      (preferred to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype)

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

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. RelatedPerson.name
      Definition

      A name associated with the person.

      ShortA name associated with the person
      Control0..*
      TypeHumanName
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      60. RelatedPerson.telecom
      Definition

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

      ShortA contact detail for the person
      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.

      Control0..*
      TypeContactPoint
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      62. RelatedPerson.gender
      Definition

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

      Shortmale | female | other | unknown
      Control0..1
      BindingThe codes SHALL be taken from AdministrativeGender
      (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

      The gender of a person used for administrative purposes.

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      64. RelatedPerson.birthDate
      Definition

      The date on which the related person was born.

      ShortThe date on which the related person was born
      Control0..1
      Typedate
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      66. RelatedPerson.address
      Definition

      Address where the related person can be contacted or visited.

      ShortAddress where the related person can be contacted or visited
      Control0..*
      TypeAddress
      Is Modifierfalse
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      68. RelatedPerson.photo
      Definition

      Image of the person.

      ShortImage of the person
      Control0..*
      TypeAttachment
      Is Modifierfalse
      Summaryfalse
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      70. RelatedPerson.period
      Definition

      Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile.

      Short✕ This element is not supported
      Control0..1
      TypePeriod
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. RelatedPerson.communication
      Definition

      A language which may be used to communicate with about the patient's health.

      ShortA language which may be used to communicate with about the patient's health
      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.

      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Summaryfalse
      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.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      74. RelatedPerson.communication.id
      Definition

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

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      76. RelatedPerson.communication.extension
      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.

      ShortAdditional content defined by implementations
      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      78. RelatedPerson.communication.modifierExtension
      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).

      ShortExtensions that cannot be ignored even if unrecognized
      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-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())
      80. RelatedPerson.communication.language
      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.

      ShortThe language which can be used to communicate with the patient about his or her health
      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.

      Control1..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      TypeCodeableConcept
      Is Modifierfalse
      Summaryfalse
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      82. RelatedPerson.communication.preferred
      Definition

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

      ShortLanguage preference indicator
      Comments

      This language is specifically identified for communicating healthcare information.

      Control0..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      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.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))