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

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

Resource Profile: Profile_R5_Person_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Person resource profile.

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

0. Person
Definition

Demographics and administrative information about a person independent of a specific health-related context.

ShortA generic person record
Comments

The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).

Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Person.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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Person.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Person.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Person.extension:deceased
    Slice Namedeceased
    Definition

    R5: Person.deceased[x] (new:boolean, dateTime)

    ShortR5: Indicates if the individual is deceased or not (new)
    Comments

    Element Person.deceased[x] has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.deceased[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Indicates if the individual is deceased or not (new)) (Extension Type: Choice of: boolean, dateTime)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Person.extension:maritalStatus
    Slice NamemaritalStatus
    Definition

    R5: Person.maritalStatus (new:CodeableConcept)

    ShortR5: Marital (civil) status of a person (new)
    Comments

    Element Person.maritalStatus has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.maritalStatus has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Marital (civil) status of a person (new)) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Person.extension:communication
    Slice Namecommunication
    Definition

    R5: Person.communication (new:BackboneElement)

    ShortR5: A language which may be used to communicate with the person about his or her health (new)
    Comments

    Element Person.communication has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.communication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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 Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

    Note that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission)

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: A language which may be used to communicate with the person about his or her health (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Person.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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    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 No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    14. Person.active
    Definition

    Whether this person's record is in active use.

    ShortThis person's record is in active use
    Control0..1
    Typeboolean
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be able to mark a person record as not to be used because it was created in error.

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

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

      R5: Person.deceased[x] (new:boolean, dateTime)

      ShortR5: Indicates if the individual is deceased or not (new)
      Comments

      Element Person.deceased[x] has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.deceased[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

      Control0..1
      TypeExtension(R5: Indicates if the individual is deceased or not (new)) (Extension Type: Choice of: boolean, dateTime)
      6. Person.extension:maritalStatus
      Slice NamemaritalStatus
      Definition

      R5: Person.maritalStatus (new:CodeableConcept)

      ShortR5: Marital (civil) status of a person (new)
      Comments

      Element Person.maritalStatus has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.maritalStatus has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction

      Control0..1
      TypeExtension(R5: Marital (civil) status of a person (new)) (Extension Type: CodeableConcept)
      8. Person.extension:communication
      Slice Namecommunication
      Definition

      R5: Person.communication (new:BackboneElement)

      ShortR5: A language which may be used to communicate with the person about his or her health (new)
      Comments

      Element Person.communication has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.communication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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 Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

      Note that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission)

      Control0..*
      TypeExtension(R5: A language which may be used to communicate with the person about his or her health (new)) (Complex Extension)
      10. Person.managingOrganization
      12. Person.managingOrganization.extension
      Control0..*
      SlicingThis element introduces a set of slices on Person.managingOrganization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 14. Person.managingOrganization.extension:managingOrganization
        Slice NamemanagingOrganization
        Definition

        R5: Person.managingOrganization additional types from child elements (display, identifier, reference, type)

        ShortR5: managingOrganization additional types
        Comments

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

        Control0..1
        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
        16. Person.link
        18. Person.link.target
        20. Person.link.target.extension
        Control0..*
        SlicingThis element introduces a set of slices on Person.link.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 22. Person.link.target.extension:target
          Slice Nametarget
          Definition

          R5: Person.link.target

          ShortR5: target
          Comments

          Element Person.link.target is mapped to FHIR STU3 element Person.link.target as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Person.link.target with unmapped reference targets: Patient, Person, Practitioner, RelatedPerson.

          Control0..1
          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)

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

          0. Person
          Definition

          Demographics and administrative information about a person independent of a specific health-related context.

          ShortA generic person record
          Comments

          The Person resource does justice to person registries that keep track of persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).

          Control0..*
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
          2. Person.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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          4. Person.meta
          Definition

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

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Summarytrue
          6. Person.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.

          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.

          This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

          Control0..1
          Typeuri
          Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          8. Person.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
          BindingUnless not suitable, these codes SHALL be taken from Common Languages .
          (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

          A human language.

          Additional BindingsPurpose
          All LanguagesMax Binding
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          10. Person.text
          Definition

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

          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 in formation is added later.

          Control0..1
          This element is affected by the following invariants: dom-1
          TypeNarrative
          Alternate Namesnarrative, html, xhtml, display
          12. Person.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.

          Control0..*
          TypeResource
          Alternate Namesinline resources, anonymous resources, contained resources
          14. Person.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          SlicingThis element introduces a set of slices on Person.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. Person.extension:deceased
            Slice Namedeceased
            Definition

            R5: Person.deceased[x] (new:boolean, dateTime)

            ShortR5: Indicates if the individual is deceased or not (new)
            Comments

            Element Person.deceased[x] has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.deceased[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(R5: Indicates if the individual is deceased or not (new)) (Extension Type: Choice of: boolean, dateTime)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            18. Person.extension:maritalStatus
            Slice NamemaritalStatus
            Definition

            R5: Person.maritalStatus (new:CodeableConcept)

            ShortR5: Marital (civil) status of a person (new)
            Comments

            Element Person.maritalStatus has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.maritalStatus has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Many countries maintain a register of births, deaths and marriages, and this would simplify that interaction

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(R5: Marital (civil) status of a person (new)) (Extension Type: CodeableConcept)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            20. Person.extension:communication
            Slice Namecommunication
            Definition

            R5: Person.communication (new:BackboneElement)

            ShortR5: A language which may be used to communicate with the person about his or her health (new)
            Comments

            Element Person.communication has a context of Person based on following the parent source element upwards and mapping to Person. Element Person.communication has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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 Person.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

            Note that this property should not be used to update any linked/logically linked practitioner resources as it serves as a language that can be used to communicate with patients - however it may be used to inform the value on practitioner, along with their role at the organization (with the practitioner's permission)

            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension(R5: A language which may be used to communicate with the person about his or her health (new)) (Complex Extension)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            22. Person.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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            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 No Modifier Reason provideed in previous versions of FHIR
            Alternate Namesextensions, user content
            24. Person.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
            Requirements

            People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.

            26. Person.name
            Definition

            A name associated with the person.

            ShortA name associated with the person
            Comments

            Person may have multiple names with different uses or applicable periods.

            Control0..*
            TypeHumanName
            Summarytrue
            Requirements

            Need to be able to track the person by multiple names. Examples are your official name and a partner name.

            28. Person.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
            Summarytrue
            Requirements

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

            30. Person.gender
            Definition

            Administrative Gender.

            Shortmale | female | other | unknown
            Comments

            The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F.

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

            The gender of a person used for administrative purposes.

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

            Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.

            32. Person.birthDate
            Definition

            The birth date for the person.

            ShortThe date on which the person was born
            Comments

            At least an estimated year should be provided as a guess if the real DOB is unknown.

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

            Age of person drives many clinical processes, and is often used in performing identification of the person. Times are not included so as to not confuse things with potential timezone issues.

            34. Person.address
            Definition

            One or more addresses for the person.

            ShortOne or more addresses for the person
            Comments

            Person may have multiple addresses with different uses or applicable periods.

            Control0..*
            TypeAddress
            Requirements

            May need to keep track of person's addresses for contacting, billing or reporting requirements and also to help with identification.

            36. Person.photo
            Definition

            An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

            ShortImage of the person
            Control0..1
            TypeAttachment
            38. Person.managingOrganization
            Definition

            The organization that is the custodian of the person record.

            ShortThe organization that is the custodian of the person record
            Control0..1
            TypeReference(Organization)
            Summarytrue
            Requirements

            Need to know who recognizes this person record, manages and updates it.

            40. Person.managingOrganization.id
            Definition

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

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            42. Person.managingOrganization.extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            SlicingThis element introduces a set of slices on Person.managingOrganization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 44. Person.managingOrganization.extension:managingOrganization
              Slice NamemanagingOrganization
              Definition

              R5: Person.managingOrganization additional types from child elements (display, identifier, reference, type)

              ShortR5: managingOrganization additional types
              Comments

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

              Control0..1
              TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
              46. Person.managingOrganization.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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              48. Person.managingOrganization.identifier
              Definition

              An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

              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.

              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..1
              TypeIdentifier
              Summarytrue
              50. Person.managingOrganization.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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              52. Person.active
              Definition

              Whether this person's record is in active use.

              ShortThis person's record is in active use
              Control0..1
              Typeboolean
              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Need to be able to mark a person record as not to be used because it was created in error.

              54. Person.link
              Definition

              Link to a resource that concerns the same actual person.

              ShortLink to a resource that concerns the same actual person
              Control0..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
              56. Person.link.id
              Definition

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

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              58. Person.link.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              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
              Alternate Namesextensions, user content
              60. Person.link.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

              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 No Modifier Reason provideed in previous versions of FHIR
              Summarytrue
              Alternate Namesextensions, user content, modifiers
              62. Person.link.target
              Definition

              The resource to which this actual person is associated.

              ShortThe resource to which this actual person is associated
              Control1..1
              TypeReference(Patient, Practitioner, RelatedPerson, Person)
              64. Person.link.target.id
              Definition

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

              Shortxml:id (or equivalent in JSON)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              XML FormatIn the XML format, this property is represented as an attribute.
              66. Person.link.target.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              SlicingThis element introduces a set of slices on Person.link.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 68. Person.link.target.extension:target
                Slice Nametarget
                Definition

                R5: Person.link.target

                ShortR5: target
                Comments

                Element Person.link.target is mapped to FHIR STU3 element Person.link.target as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Person.link.target with unmapped reference targets: Patient, Person, Practitioner, RelatedPerson.

                Control0..1
                TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                70. Person.link.target.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
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                72. Person.link.target.identifier
                Definition

                An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                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.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..1
                TypeIdentifier
                Summarytrue
                74. Person.link.target.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
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                76. Person.link.assurance
                Definition

                Level of assurance that this link is actually associated with the target resource.

                Shortlevel1 | level2 | level3 | level4
                Control0..1
                BindingThe codes SHALL be taken from IdentityAssuranceLevel
                (required to http://hl7.org/fhir/ValueSet/identity-assuranceLevel|3.0.2)

                The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension