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

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

Resource Profile: Profile_R4B_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.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
6. 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.meta
4. Person.meta.extension
Control0..*
SlicingThis element introduces a set of slices on Person.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Person.meta.extension:meta
    Slice Namemeta
    Definition

    R4B: Person.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

    ShortR4B: meta additional types
    Comments

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

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

      R4B: Person.text additional types (Narrative) additional types from child elements (div, status)

      ShortR4B: text additional types
      Comments

      Element Person.text is mapped to FHIR STU3 element Person.text as SourceIsBroaderThanTarget. The mappings for Person.text do not cover the following types: Narrative. The mappings for Person.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 information is added later.

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

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

        ShortR4B: identifier additional types
        Comments

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

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

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

          ShortR4B: name additional types
          Comments

          Element Person.name is mapped to FHIR STU3 element Person.name as SourceIsBroaderThanTarget. The mappings for Person.name do not cover the following types: HumanName. The mappings for Person.name do not cover the following types based on type expansion: family, given, period, prefix, suffix, text, use. Person may have multiple names with different uses or applicable periods.

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

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

            ShortR4B: telecom additional types
            Comments

            Element Person.telecom is mapped to FHIR STU3 element Person.telecom as SourceIsBroaderThanTarget. The mappings for Person.telecom do not cover the following types: ContactPoint. The mappings for Person.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(R4B: telecom additional types) (Extension Type: ContactPoint)
            32. Person.address
            34. Person.address.extension
            Control0..*
            SlicingThis element introduces a set of slices on Person.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 36. Person.address.extension:address
              Slice Nameaddress
              Definition

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

              ShortR4B: address additional types
              Comments

              Element Person.address is mapped to FHIR STU3 element Person.address as SourceIsBroaderThanTarget. The mappings for Person.address do not cover the following types: Address. The mappings for Person.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use. Person may have multiple addresses with different uses or applicable periods.

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

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

                ShortR4B: photo additional types
                Comments

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

                Control0..1
                TypeExtension(R4B: photo additional types) (Extension Type: Attachment)
                44. Person.managingOrganization
                46. 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
                • 48. Person.managingOrganization.extension:managingOrganization
                  Slice NamemanagingOrganization
                  Definition

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

                  ShortR4B: 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 R4B element Person.managingOrganization with unmapped reference targets: Organization.

                  Control0..1
                  TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                  50. Person.link
                  52. Person.link.target
                  54. 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
                  • 56. Person.link.target.extension:target
                    Slice Nametarget
                    Definition

                    R4B: Person.link.target

                    ShortR4B: 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 R4B 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.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.

                    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.
                    8. Person.meta.extension
                    Definition

                    An Extension

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

                      R4B: Person.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

                      ShortR4B: meta additional types
                      Comments

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

                      Control0..1
                      TypeExtension(R4B: meta additional types) (Extension Type: Meta)
                      12. Person.meta.versionId
                      Definition

                      The version specific identifier, as it appears in the version portion of the URL. This values 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
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      14. Person.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.

                      Control0..1
                      Typeinstant
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      16. Person.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..*
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      18. Person.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|3.0.2)

                      Security Labels from the Healthcare Privacy and Security Classification System.

                      TypeCoding
                      Summarytrue
                      20. Person.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 Common Tags
                      (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)

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

                      TypeCoding
                      Summarytrue
                      22. 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
                      24. 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
                      26. 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
                      28. Person.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.

                      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.
                      30. Person.text.extension
                      Definition

                      An Extension

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

                        R4B: Person.text additional types (Narrative) additional types from child elements (div, status)

                        ShortR4B: text additional types
                        Comments

                        Element Person.text is mapped to FHIR STU3 element Person.text as SourceIsBroaderThanTarget. The mappings for Person.text do not cover the following types: Narrative. The mappings for Person.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 information is added later.

                        Control0..1
                        TypeExtension(R4B: text additional types) (Complex Extension)
                        34. Person.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|3.0.2)

                        The status of a resource narrative

                        Typecode
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        36. Person.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 may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                        Control1..1
                        Typexhtml
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Invariantstxt-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())
                        38. 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
                        40. Person.extension
                        Definition

                        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.

                        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
                        42. 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
                        44. 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.

                        46. Person.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.

                        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.
                        48. Person.identifier.extension
                        Definition

                        An Extension

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

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

                          ShortR4B: identifier additional types
                          Comments

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

                          Control0..*
                          TypeExtension(R4B: identifier additional types) (Extension Type: Identifier)
                          52. Person.identifier.use
                          Definition

                          The purpose of this identifier.

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

                          This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

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

                          Identifies the purpose for this identifier, if known .

                          Typecode
                          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

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

                          54. Person.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|3.0.2)

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

                          TypeCodeableConcept
                          Summarytrue
                          Requirements

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

                          56. Person.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
                          Control0..1
                          Typeuri
                          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
                          58. Person.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.

                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          ExampleGeneral: 123456
                          60. Person.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
                          Summarytrue
                          62. Person.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)
                          Summarytrue
                          64. 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.

                          66. Person.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.

                          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.
                          68. Person.name.extension
                          Definition

                          An Extension

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

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

                            ShortR4B: name additional types
                            Comments

                            Element Person.name is mapped to FHIR STU3 element Person.name as SourceIsBroaderThanTarget. The mappings for Person.name do not cover the following types: HumanName. The mappings for Person.name do not cover the following types based on type expansion: family, given, period, prefix, suffix, text, use. Person may have multiple names with different uses or applicable periods.

                            Control0..*
                            TypeExtension(R4B: name additional types) (Extension Type: HumanName)
                            72. Person.name.use
                            Definition

                            Identifies the purpose for this name.

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

                            This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                            Control0..1
                            BindingThe codes SHALL be taken from NameUse
                            (required to http://hl7.org/fhir/ValueSet/name-use|3.0.2)

                            The use of a human name

                            Typecode
                            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

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

                            74. Person.name.text
                            Definition

                            A full text representation of the name.

                            ShortText representation of the full name
                            Comments

                            Can provide both a text representation and structured parts.

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

                            A renderable, unencoded form.

                            76. Person.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
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Alternate Namessurname
                            78. Person.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. Not called "first name" since given names do not always come first.

                            Control0..*
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Alternate Namesfirst name, middle name
                            80. Person.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
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            82. Person.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
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            84. Person.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
                            Summarytrue
                            Requirements

                            Allows names to be placed in historical context.

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

                            88. Person.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.

                            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.
                            90. Person.telecom.extension
                            Definition

                            An Extension

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

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

                              ShortR4B: telecom additional types
                              Comments

                              Element Person.telecom is mapped to FHIR STU3 element Person.telecom as SourceIsBroaderThanTarget. The mappings for Person.telecom do not cover the following types: ContactPoint. The mappings for Person.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(R4B: telecom additional types) (Extension Type: ContactPoint)
                              94. Person.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|3.0.2)

                              Telecommunications form for contact point

                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              96. Person.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
                              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.

                              98. Person.telecom.use
                              Definition

                              Identifies the purpose for the contact point.

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

                              This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                              Control0..1
                              BindingThe codes SHALL be taken from ContactPointUse
                              (required to http://hl7.org/fhir/ValueSet/contact-point-use|3.0.2)

                              Use of contact point

                              Typecode
                              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 track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                              100. Person.telecom.rank
                              Definition

                              Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher 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
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              102. Person.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
                              Summarytrue
                              104. 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.

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

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

                              110. Person.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.

                              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.
                              112. Person.address.extension
                              Definition

                              An Extension

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

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

                                ShortR4B: address additional types
                                Comments

                                Element Person.address is mapped to FHIR STU3 element Person.address as SourceIsBroaderThanTarget. The mappings for Person.address do not cover the following types: Address. The mappings for Person.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use. Person may have multiple addresses with different uses or applicable periods.

                                Control0..*
                                TypeExtension(R4B: address additional types) (Extension Type: Address)
                                116. Person.address.use
                                Definition

                                The purpose of this address.

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

                                This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.

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

                                The use of an address

                                Typecode
                                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

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

                                ExampleGeneral: home
                                118. Person.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
                                Control0..1
                                BindingThe codes SHALL be taken from AddressType
                                (required to http://hl7.org/fhir/ValueSet/address-type|3.0.2)

                                The type of an address (physical / postal)

                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                ExampleGeneral: both
                                120. Person.address.text
                                Definition

                                A full text representation of the address.

                                ShortText representation of the address
                                Comments

                                Can provide both a text representation and parts.

                                Control0..1
                                Typestring
                                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
                                122. Person.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
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

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

                                ExampleGeneral: 137 Nowhere Street
                                124. Person.address.city
                                Definition

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

                                ShortName of city, town etc.
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesMunicpality
                                ExampleGeneral: Erewhon
                                126. Person.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
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesCounty
                                ExampleGeneral: Madison
                                128. Person.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 (i.e. US 2 letter state codes).

                                ShortSub-unit of country (abbreviations ok)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesProvince, Territory
                                130. Person.address.postalCode
                                Definition

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

                                ShortPostal code for area
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesZip
                                ExampleGeneral: 9132
                                132. Person.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 full country name.

                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                134. Person.address.period
                                Definition

                                Time period when address was/is in use.

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

                                Allows addresses to be placed in historical context.

                                ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
                                136. 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
                                138. Person.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.

                                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.
                                140. Person.photo.extension
                                Definition

                                An Extension

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

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

                                  ShortR4B: photo additional types
                                  Comments

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

                                  Control0..1
                                  TypeExtension(R4B: photo additional types) (Extension Type: Attachment)
                                  144. Person.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
                                  (required to http://hl7.org/fhir/ValueSet/mimetypes)

                                  The mime type of an attachment. Any valid mime type is allowed.

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

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

                                  ExampleGeneral: en-AU
                                  148. Person.photo.data
                                  Definition

                                  The actual data of the attachment - a sequence of bytes. In XML, represented using base64.

                                  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
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Requirements

                                  The data needs to able to be transmitted inline.

                                  150. Person.photo.url
                                  Definition

                                  An alternative 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
                                  Typeuri
                                  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
                                  152. Person.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
                                  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.

                                  154. Person.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.

                                  Control0..1
                                  Typebase64Binary
                                  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 and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.

                                  156. Person.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
                                  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
                                  158. Person.photo.creation
                                  Definition

                                  The date that the attachment was first created.

                                  ShortDate attachment was first created
                                  Control0..1
                                  TypedateTime
                                  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.

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

                                  162. 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.
                                  164. 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
                                  • 166. Person.managingOrganization.extension:managingOrganization
                                    Slice NamemanagingOrganization
                                    Definition

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

                                    ShortR4B: 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 R4B element Person.managingOrganization with unmapped reference targets: Organization.

                                    Control0..1
                                    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                    168. 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
                                    170. 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
                                    172. 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
                                    174. 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.

                                    176. 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()))
                                    178. 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.
                                    180. 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
                                    182. 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
                                    184. 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)
                                    186. 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.
                                    188. 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
                                    • 190. Person.link.target.extension:target
                                      Slice Nametarget
                                      Definition

                                      R4B: Person.link.target

                                      ShortR4B: 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 R4B element Person.link.target with unmapped reference targets: Patient, Person, Practitioner, RelatedPerson.

                                      Control0..1
                                      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                      192. 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
                                      194. 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
                                      196. 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
                                      198. 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