Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_RelatedPerson_R4B - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-RelatedPerson resource profile.

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

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
Must Supportfalse
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.exists() and ('#'+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(uri) = '#').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())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+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(uri) = '#').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.

Control0..1
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
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. RelatedPerson.modifierExtension
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).

ShortExtensions that cannot be ignored
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 resource that contains them
Must Supportfalse
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())
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())
6. RelatedPerson.active
Definition

Whether this related person record is in active use.

ShortWhether 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
Must Supportfalse
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()))
ele-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
Must Supportfalse
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()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. RelatedPerson.patient.extension
Definition

An Extension


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.

ShortExtensionAdditional 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())
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())
SlicingThis element introduces a set of slices on RelatedPerson.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. RelatedPerson.patient.extension:patient
    Slice Namepatient
    Definition

    STU3: RelatedPerson.patient additional types from child elements (display, identifier, reference)

    ShortSTU3: patient additional types
    Comments

    Element RelatedPerson.patient is mapped to FHIR R4B element RelatedPerson.patient as SourceIsBroaderThanTarget. The mappings for RelatedPerson.patient do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element RelatedPerson.patient with unmapped reference targets: Patient.

    Control0..1
    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
    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())
    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())

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

    0. RelatedPerson
    2. RelatedPerson.meta
    4. RelatedPerson.meta.extension
    Control0..*
    SlicingThis element introduces a set of slices on RelatedPerson.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. RelatedPerson.meta.extension:meta
      Slice Namemeta
      Definition

      STU3: RelatedPerson.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

      ShortSTU3: meta additional types
      Comments

      Element RelatedPerson.meta is mapped to FHIR R4B element RelatedPerson.meta as SourceIsBroaderThanTarget. The mappings for RelatedPerson.meta do not cover the following types: Meta. The mappings for RelatedPerson.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

      Control0..1
      TypeExtension(STU3: meta additional types) (Complex Extension)
      8. RelatedPerson.text
      10. RelatedPerson.text.extension
      Control0..*
      SlicingThis element introduces a set of slices on RelatedPerson.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. RelatedPerson.text.extension:text
        Slice Nametext
        Definition

        STU3: RelatedPerson.text additional types (Narrative) additional types from child elements (div, status)

        ShortSTU3: text additional types
        Comments

        Element RelatedPerson.text is mapped to FHIR R4B element RelatedPerson.text as SourceIsBroaderThanTarget. The mappings for RelatedPerson.text do not cover the following types: Narrative. The mappings for RelatedPerson.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

        Control0..1
        TypeExtension(STU3: text additional types) (Complex Extension)
        14. RelatedPerson.identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        16. RelatedPerson.identifier.extension
        Control0..*
        SlicingThis element introduces a set of slices on RelatedPerson.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 18. RelatedPerson.identifier.extension:identifier
          Slice Nameidentifier
          Definition

          STU3: RelatedPerson.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

          ShortSTU3: identifier additional types
          Comments

          Element RelatedPerson.identifier is mapped to FHIR R4B element RelatedPerson.identifier as SourceIsBroaderThanTarget. The mappings for RelatedPerson.identifier do not cover the following types: Identifier. The mappings for RelatedPerson.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

          Control0..*
          TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
          20. RelatedPerson.patient
          22. RelatedPerson.patient.extension
          Control0..*
          SlicingThis element introduces a set of slices on RelatedPerson.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 24. RelatedPerson.patient.extension:patient
            Slice Namepatient
            Definition

            STU3: RelatedPerson.patient additional types from child elements (display, identifier, reference)

            ShortSTU3: patient additional types
            Comments

            Element RelatedPerson.patient is mapped to FHIR R4B element RelatedPerson.patient as SourceIsBroaderThanTarget. The mappings for RelatedPerson.patient do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element RelatedPerson.patient with unmapped reference targets: Patient.

            Control0..1
            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
            26. RelatedPerson.name
            28. RelatedPerson.name.extension
            Control0..*
            SlicingThis element introduces a set of slices on RelatedPerson.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 30. RelatedPerson.name.extension:name
              Slice Namename
              Definition

              STU3: RelatedPerson.name additional types (HumanName) additional types from child elements (family, given, period, prefix, suffix, text, use)

              ShortSTU3: name additional types
              Comments

              Element RelatedPerson.name is mapped to FHIR R4B element RelatedPerson.name as SourceIsBroaderThanTarget. The mappings for RelatedPerson.name do not cover the following types: HumanName. The mappings for RelatedPerson.name do not cover the following types based on type expansion: family, given, period, prefix, suffix, text, use.

              Control0..*
              TypeExtension(STU3: name additional types) (Extension Type: HumanName)
              32. RelatedPerson.telecom
              34. RelatedPerson.telecom.extension
              Control0..*
              SlicingThis element introduces a set of slices on RelatedPerson.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 36. RelatedPerson.telecom.extension:telecom
                Slice Nametelecom
                Definition

                STU3: RelatedPerson.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

                ShortSTU3: telecom additional types
                Comments

                Element RelatedPerson.telecom is mapped to FHIR R4B element RelatedPerson.telecom as SourceIsBroaderThanTarget. The mappings for RelatedPerson.telecom do not cover the following types: ContactPoint. The mappings for RelatedPerson.telecom do not cover the following types based on type expansion: period, rank, system, use, value. 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..*
                TypeExtension(STU3: telecom additional types) (Extension Type: ContactPoint)
                38. RelatedPerson.address
                40. RelatedPerson.address.extension
                Control0..*
                SlicingThis element introduces a set of slices on RelatedPerson.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 42. RelatedPerson.address.extension:address
                  Slice Nameaddress
                  Definition

                  STU3: RelatedPerson.address additional types (Address) additional types from child elements (city, country, district, line, period, postalCode, state, text, type, use)

                  ShortSTU3: address additional types
                  Comments

                  Element RelatedPerson.address is mapped to FHIR R4B element RelatedPerson.address as SourceIsBroaderThanTarget. The mappings for RelatedPerson.address do not cover the following types: Address. The mappings for RelatedPerson.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use.

                  Control0..*
                  TypeExtension(STU3: address additional types) (Extension Type: Address)
                  44. RelatedPerson.photo
                  46. RelatedPerson.photo.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on RelatedPerson.photo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 48. RelatedPerson.photo.extension:photo
                    Slice Namephoto
                    Definition

                    STU3: RelatedPerson.photo additional types (Attachment) additional types from child elements (contentType, creation, data, hash, language, size, title, url)

                    ShortSTU3: photo additional types
                    Comments

                    Element RelatedPerson.photo is mapped to FHIR R4B element RelatedPerson.photo as SourceIsBroaderThanTarget. The mappings for RelatedPerson.photo do not cover the following types: Attachment. The mappings for RelatedPerson.photo do not cover the following types based on type expansion: contentType, creation, data, hash, language, size, title, url.

                    Control0..*
                    TypeExtension(STU3: photo additional types) (Extension Type: Attachment)
                    50. RelatedPerson.period
                    52. RelatedPerson.period.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on RelatedPerson.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 54. RelatedPerson.period.extension:period
                      Slice Nameperiod
                      Definition

                      STU3: RelatedPerson.period additional types (Period) additional types from child elements (end, start)

                      ShortSTU3: period additional types
                      Comments

                      Element RelatedPerson.period is mapped to FHIR R4B element RelatedPerson.period as SourceIsBroaderThanTarget. The mappings for RelatedPerson.period do not cover the following types: Period. The mappings for RelatedPerson.period do not cover the following types based on type expansion: end, start.

                      Control0..1
                      TypeExtension(STU3: period additional types) (Extension Type: Period)

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

                      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
                      Must Supportfalse
                      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.exists() and ('#'+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(uri) = '#').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
                      Must Supportfalse
                      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
                      Must Supportfalse
                      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
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      8. RelatedPerson.meta.extension
                      Definition

                      An Extension

                      ShortExtension
                      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 areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 10. RelatedPerson.meta.extension:meta
                        Slice Namemeta
                        Definition

                        STU3: RelatedPerson.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                        ShortSTU3: meta additional types
                        Comments

                        Element RelatedPerson.meta is mapped to FHIR R4B element RelatedPerson.meta as SourceIsBroaderThanTarget. The mappings for RelatedPerson.meta do not cover the following types: Meta. The mappings for RelatedPerson.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

                        Control0..1
                        TypeExtension(STU3: meta additional types) (Complex Extension)
                        Is Modifierfalse
                        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())
                        12. RelatedPerson.meta.versionId
                        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.

                        ShortVersion specific identifier
                        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()))
                        14. RelatedPerson.meta.lastUpdated
                        Definition

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

                        ShortWhen the resource version last 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.

                        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()))
                        16. RelatedPerson.meta.source
                        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.

                        ShortIdentifies where the resource comes from
                        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()))
                        18. 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()))
                        20. RelatedPerson.meta.security
                        Definition

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

                        ShortSecurity Labels applied to this resource
                        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|4.3.0)
                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        22. RelatedPerson.meta.tag
                        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.

                        ShortTags applied to this 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.

                        Control0..*
                        BindingFor example codes, see CommonTags
                        (example to http://hl7.org/fhir/ValueSet/common-tags|4.3.0)
                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        24. 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.

                        Control0..1
                        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
                        Must Supportfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        26. 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|4.3.0)

                        IETF language tag

                        Additional BindingsPurpose
                        AllLanguagesMax Binding
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        28. 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
                        Must Supportfalse
                        Summaryfalse
                        Alternate Namesnarrative, html, xhtml, display
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        30. RelatedPerson.text.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
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        32. RelatedPerson.text.extension
                        Definition

                        An Extension

                        ShortExtension
                        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.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 34. RelatedPerson.text.extension:text
                          Slice Nametext
                          Definition

                          STU3: RelatedPerson.text additional types (Narrative) additional types from child elements (div, status)

                          ShortSTU3: text additional types
                          Comments

                          Element RelatedPerson.text is mapped to FHIR R4B element RelatedPerson.text as SourceIsBroaderThanTarget. The mappings for RelatedPerson.text do not cover the following types: Narrative. The mappings for RelatedPerson.text do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

                          Control0..1
                          TypeExtension(STU3: text additional types) (Complex Extension)
                          Is Modifierfalse
                          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())
                          36. RelatedPerson.text.status
                          Definition

                          The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                          Shortgenerated | extensions | additional | empty
                          Control1..1
                          BindingThe codes SHALL be taken from NarrativeStatus
                          (required to http://hl7.org/fhir/ValueSet/narrative-status|4.3.0)
                          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()))
                          38. RelatedPerson.text.div
                          Definition

                          The actual narrative content, a stripped down version of XHTML.

                          ShortLimited xhtml content
                          Comments

                          The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                          Control1..1
                          Typexhtml
                          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()))
                          txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks())
                          txt-2: The narrative SHALL have some non-whitespace content (htmlChecks())
                          40. 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
                          Must Supportfalse
                          Summaryfalse
                          Alternate Namesinline resources, anonymous resources, contained resources
                          Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                          42. 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
                          Must Supportfalse
                          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())
                          44. RelatedPerson.modifierExtension
                          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).

                          ShortExtensions that cannot be ignored
                          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 resource that contains them
                          Must Supportfalse
                          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())
                          46. 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
                          Must Supportfalse
                          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()))
                          48. 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
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          50. RelatedPerson.identifier.extension
                          Definition

                          An Extension

                          ShortExtension
                          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 areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 52. RelatedPerson.identifier.extension:identifier
                            Slice Nameidentifier
                            Definition

                            STU3: RelatedPerson.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                            ShortSTU3: identifier additional types
                            Comments

                            Element RelatedPerson.identifier is mapped to FHIR R4B element RelatedPerson.identifier as SourceIsBroaderThanTarget. The mappings for RelatedPerson.identifier do not cover the following types: Identifier. The mappings for RelatedPerson.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                            Control0..*
                            TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
                            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())
                            54. 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.3.0)
                            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()))
                            56. RelatedPerson.identifier.type
                            Definition

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

                            ShortDescription of identifier
                            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|4.3.0)
                            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()))
                            58. 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.

                            ExampleGeneral: http://www.acme.com/identifiers/patient
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            60. 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
                            ExampleGeneral: 123456
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            62. RelatedPerson.identifier.period
                            Definition

                            Time period during which identifier is/was valid for use.

                            ShortTime period when id is/was valid for use
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            64. RelatedPerson.identifier.assigner
                            Definition

                            Organization that issued/manages the identifier.

                            ShortOrganization that issued id (may be just text)
                            Comments

                            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

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

                            Whether this related person record is in active use.

                            ShortWhether 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
                            Must Supportfalse
                            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()))
                            68. RelatedPerson.patient
                            Definition

                            The patient this person is related to.

                            ShortThe patient this person is related to
                            Control1..1
                            TypeReference(Patient)
                            Is Modifierfalse
                            Must Supportfalse
                            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()))
                            70. RelatedPerson.patient.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
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            72. RelatedPerson.patient.extension
                            Definition

                            An Extension

                            ShortExtension
                            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.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 74. RelatedPerson.patient.extension:patient
                              Slice Namepatient
                              Definition

                              STU3: RelatedPerson.patient additional types from child elements (display, identifier, reference)

                              ShortSTU3: patient additional types
                              Comments

                              Element RelatedPerson.patient is mapped to FHIR R4B element RelatedPerson.patient as SourceIsBroaderThanTarget. The mappings for RelatedPerson.patient do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element RelatedPerson.patient with unmapped reference targets: Patient.

                              Control0..1
                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                              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())
                              76. RelatedPerson.patient.reference
                              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.

                              ShortLiteral reference, Relative, internal or absolute URL
                              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.

                              Control0..1
                              This element is affected by the following invariants: ref-1
                              Typestring
                              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()))
                              78. RelatedPerson.patient.type
                              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).

                              ShortType the reference refers to (e.g. "Patient")
                              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.

                              Control0..1
                              BindingUnless not suitable, these codes SHALL be taken from ResourceType
                              (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.3.0)
                              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()))
                              80. RelatedPerson.patient.identifier
                              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.

                              ShortLogical reference, when literal reference is not known
                              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).

                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control0..1
                              TypeIdentifier
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              82. RelatedPerson.patient.display
                              Definition

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

                              ShortText alternative for the resource
                              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.

                              Control0..1
                              Typestring
                              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()))
                              84. 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|4.3.0)

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

                              TypeCodeableConcept
                              Is Modifierfalse
                              Must Supportfalse
                              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()))
                              86. RelatedPerson.name
                              Definition

                              A name associated with the person.

                              ShortA name associated with the person
                              Control0..*
                              TypeHumanName
                              Is Modifierfalse
                              Must Supportfalse
                              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()))
                              88. RelatedPerson.name.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
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              90. RelatedPerson.name.extension
                              Definition

                              An Extension

                              ShortExtension
                              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.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 92. RelatedPerson.name.extension:name
                                Slice Namename
                                Definition

                                STU3: RelatedPerson.name additional types (HumanName) additional types from child elements (family, given, period, prefix, suffix, text, use)

                                ShortSTU3: name additional types
                                Comments

                                Element RelatedPerson.name is mapped to FHIR R4B element RelatedPerson.name as SourceIsBroaderThanTarget. The mappings for RelatedPerson.name do not cover the following types: HumanName. The mappings for RelatedPerson.name do not cover the following types based on type expansion: family, given, period, prefix, suffix, text, use.

                                Control0..*
                                TypeExtension(STU3: name additional types) (Extension Type: HumanName)
                                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())
                                94. RelatedPerson.name.use
                                Definition

                                Identifies the purpose for this name.

                                Shortusual | official | temp | nickname | anonymous | old | maiden
                                Comments

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

                                Control0..1
                                BindingThe codes SHALL be taken from NameUse
                                (required to http://hl7.org/fhir/ValueSet/name-use|4.3.0)
                                Typecode
                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                96. RelatedPerson.name.text
                                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.

                                ShortText representation of the full name
                                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.

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

                                A renderable, unencoded form.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                98. RelatedPerson.name.family
                                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.

                                ShortFamily name (often called 'Surname')
                                Comments

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

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

                                Given name.

                                ShortGiven names (not always 'first'). Includes middle names
                                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.

                                Control0..*
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate Namesfirst name, middle name
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                102. RelatedPerson.name.prefix
                                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.

                                ShortParts that come before the name
                                Control0..*
                                Typestring
                                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()))
                                104. RelatedPerson.name.suffix
                                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.

                                ShortParts that come after the name
                                Control0..*
                                Typestring
                                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()))
                                106. RelatedPerson.name.period
                                Definition

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

                                ShortTime period when name was/is in use
                                Control0..1
                                TypePeriod
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Allows names to be placed in historical context.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                108. 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
                                Must Supportfalse
                                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()))
                                110. RelatedPerson.telecom.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
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                112. RelatedPerson.telecom.extension
                                Definition

                                An Extension

                                ShortExtension
                                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.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 114. RelatedPerson.telecom.extension:telecom
                                  Slice Nametelecom
                                  Definition

                                  STU3: RelatedPerson.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

                                  ShortSTU3: telecom additional types
                                  Comments

                                  Element RelatedPerson.telecom is mapped to FHIR R4B element RelatedPerson.telecom as SourceIsBroaderThanTarget. The mappings for RelatedPerson.telecom do not cover the following types: ContactPoint. The mappings for RelatedPerson.telecom do not cover the following types based on type expansion: period, rank, system, use, value. 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..*
                                  TypeExtension(STU3: telecom additional types) (Extension Type: ContactPoint)
                                  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())
                                  116. RelatedPerson.telecom.system
                                  Definition

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

                                  Shortphone | fax | email | pager | url | sms | other
                                  Control0..1
                                  This element is affected by the following invariants: cpt-2
                                  BindingThe codes SHALL be taken from ContactPointSystem
                                  (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
                                  Typecode
                                  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()))
                                  118. RelatedPerson.telecom.value
                                  Definition

                                  The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                  ShortThe actual contact point details
                                  Comments

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

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

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

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

                                  Identifies the purpose for the contact point.

                                  Shorthome | work | temp | old | mobile - purpose of this contact point
                                  Comments

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

                                  Control0..1
                                  BindingThe codes SHALL be taken from ContactPointUse
                                  (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                  Typecode
                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

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

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  122. RelatedPerson.telecom.rank
                                  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.

                                  ShortSpecify preferred order of use (1 = highest)
                                  Comments

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

                                  Control0..1
                                  TypepositiveInt
                                  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()))
                                  124. RelatedPerson.telecom.period
                                  Definition

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

                                  ShortTime period when the contact point was/is in use
                                  Control0..1
                                  TypePeriod
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  126. 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.3.0)

                                  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
                                  Must Supportfalse
                                  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()))
                                  128. 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
                                  Must Supportfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  130. 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
                                  Must Supportfalse
                                  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()))
                                  132. RelatedPerson.address.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
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  134. RelatedPerson.address.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  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.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 136. RelatedPerson.address.extension:address
                                    Slice Nameaddress
                                    Definition

                                    STU3: RelatedPerson.address additional types (Address) additional types from child elements (city, country, district, line, period, postalCode, state, text, type, use)

                                    ShortSTU3: address additional types
                                    Comments

                                    Element RelatedPerson.address is mapped to FHIR R4B element RelatedPerson.address as SourceIsBroaderThanTarget. The mappings for RelatedPerson.address do not cover the following types: Address. The mappings for RelatedPerson.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use.

                                    Control0..*
                                    TypeExtension(STU3: address additional types) (Extension Type: Address)
                                    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())
                                    138. RelatedPerson.address.use
                                    Definition

                                    The purpose of this address.

                                    Shorthome | work | temp | old | billing - purpose of this address
                                    Comments

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

                                    Control0..1
                                    BindingThe codes SHALL be taken from AddressUse
                                    (required to http://hl7.org/fhir/ValueSet/address-use|4.3.0)

                                    The use of an address (home / work / etc.).

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

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

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

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

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

                                    Control0..1
                                    BindingThe codes SHALL be taken from AddressType
                                    (required to http://hl7.org/fhir/ValueSet/address-type|4.3.0)

                                    The type of an address (physical / postal).

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

                                    ShortText representation of the address
                                    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.

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

                                    A renderable, unencoded form.

                                    ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    144. RelatedPerson.address.line
                                    Definition

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

                                    ShortStreet name, number, direction & P.O. Box etc.
                                    Control0..*
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    ExampleGeneral: 137 Nowhere Street
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    146. RelatedPerson.address.city
                                    Definition

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

                                    ShortName of city, town etc.
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Alternate NamesMunicpality
                                    ExampleGeneral: Erewhon
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    148. RelatedPerson.address.district
                                    Definition

                                    The name of the administrative area (county).

                                    ShortDistrict name (aka 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.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Alternate NamesCounty
                                    ExampleGeneral: Madison
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    150. RelatedPerson.address.state
                                    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).

                                    ShortSub-unit of country (abbreviations ok)
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Alternate NamesProvince, Territory
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    152. RelatedPerson.address.postalCode
                                    Definition

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

                                    ShortPostal code for area
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Alternate NamesZip
                                    ExampleGeneral: 9132
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    154. RelatedPerson.address.country
                                    Definition

                                    Country - a nation as commonly understood or generally accepted.

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

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

                                    Control0..1
                                    Typestring
                                    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()))
                                    156. RelatedPerson.address.period
                                    Definition

                                    Time period when address was/is in use.

                                    ShortTime period when address was/is in use
                                    Control0..1
                                    TypePeriod
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

                                    Allows addresses to be placed in historical context.

                                    ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    158. RelatedPerson.photo
                                    Definition

                                    Image of the person.

                                    ShortImage of the person
                                    Control0..*
                                    TypeAttachment
                                    Is Modifierfalse
                                    Must Supportfalse
                                    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()))
                                    160. RelatedPerson.photo.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
                                    Typeid
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    162. RelatedPerson.photo.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    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.photo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 164. RelatedPerson.photo.extension:photo
                                      Slice Namephoto
                                      Definition

                                      STU3: RelatedPerson.photo additional types (Attachment) additional types from child elements (contentType, creation, data, hash, language, size, title, url)

                                      ShortSTU3: photo additional types
                                      Comments

                                      Element RelatedPerson.photo is mapped to FHIR R4B element RelatedPerson.photo as SourceIsBroaderThanTarget. The mappings for RelatedPerson.photo do not cover the following types: Attachment. The mappings for RelatedPerson.photo do not cover the following types based on type expansion: contentType, creation, data, hash, language, size, title, url.

                                      Control0..*
                                      TypeExtension(STU3: photo additional types) (Extension Type: Attachment)
                                      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())
                                      166. RelatedPerson.photo.contentType
                                      Definition

                                      Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

                                      ShortMime type of the content, with charset etc.
                                      Control0..1
                                      BindingThe codes SHALL be taken from Mime Types
                                      (required to http://hl7.org/fhir/ValueSet/mimetypes|4.3.0)

                                      BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

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

                                      Processors of the data need to be able to know how to interpret the data.

                                      ExampleGeneral: text/plain; charset=UTF-8, image/png
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      168. RelatedPerson.photo.language
                                      Definition

                                      The human language of the content. The value can be any valid value according to BCP 47.

                                      ShortHuman language of the content (BCP-47)
                                      Control0..1
                                      BindingThe codes SHOULD be taken from CommonLanguages
                                      (preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)

                                      IETF language tag

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

                                      Users need to be able to choose between the languages in a set of attachments.

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

                                      The actual data of the attachment - a sequence of bytes, base64 encoded.

                                      ShortData inline, base64ed
                                      Comments

                                      The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

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

                                      The data needs to able to be transmitted inline.

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

                                      A location where the data can be accessed.

                                      ShortUri where the data can be found
                                      Comments

                                      If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

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

                                      The data needs to be transmitted by reference.

                                      ExampleGeneral: http://www.acme.com/logo-small.png
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      174. RelatedPerson.photo.size
                                      Definition

                                      The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

                                      ShortNumber of bytes of content (if url provided)
                                      Comments

                                      The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

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

                                      Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

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

                                      The calculated hash of the data using SHA-1. Represented using base64.

                                      ShortHash of the data (sha-1, base64ed)
                                      Comments

                                      The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

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

                                      Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

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

                                      A label or set of text to display in place of the data.

                                      ShortLabel to display in place of the data
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

                                      ExampleGeneral: Official Corporate Logo
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      180. RelatedPerson.photo.creation
                                      Definition

                                      The date that the attachment was first created.

                                      ShortDate attachment was first created
                                      Control0..1
                                      TypedateTime
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Requirements

                                      This is often tracked as an integrity issue for use of the attachment.

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

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

                                      ShortPeriod of time that this relationship is considered valid
                                      Control0..1
                                      TypePeriod
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      184. RelatedPerson.period.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
                                      Typeid
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      186. RelatedPerson.period.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      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.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 188. RelatedPerson.period.extension:period
                                        Slice Nameperiod
                                        Definition

                                        STU3: RelatedPerson.period additional types (Period) additional types from child elements (end, start)

                                        ShortSTU3: period additional types
                                        Comments

                                        Element RelatedPerson.period is mapped to FHIR R4B element RelatedPerson.period as SourceIsBroaderThanTarget. The mappings for RelatedPerson.period do not cover the following types: Period. The mappings for RelatedPerson.period do not cover the following types based on type expansion: end, start.

                                        Control0..1
                                        TypeExtension(STU3: period additional types) (Extension Type: Period)
                                        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())
                                        190. RelatedPerson.period.start
                                        Definition

                                        The start of the period. The boundary is inclusive.

                                        ShortStarting time with inclusive boundary
                                        Comments

                                        If the low element is missing, the meaning is that the low boundary is not known.

                                        Control0..1
                                        This element is affected by the following invariants: per-1
                                        TypedateTime
                                        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()))
                                        192. RelatedPerson.period.end
                                        Definition

                                        The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                        ShortEnd time with inclusive boundary, if not ongoing
                                        Comments

                                        The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                        Control0..1
                                        This element is affected by the following invariants: per-1
                                        TypedateTime
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        194. 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
                                        Must Supportfalse
                                        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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                        196. 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
                                        198. 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())
                                        200. 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())
                                        202. 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|4.3.0)

                                        IETF language tag

                                        Additional BindingsPurpose
                                        AllLanguagesMax Binding
                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supportfalse
                                        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()))
                                        204. 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
                                        Must Supportfalse
                                        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()))