Implementation Guide
23.0.0 - R4 APIs

Publish Box goes here

Resource Profile: AthenaPatient - Detailed Descriptions

Active as of 2022-03-01

Definitions for the athena-patient-profile resource profile.

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

0. Patient
Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

ShortInformation about an individual or animal receiving health care services
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesSubjectOfCare Client Resident
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Patient.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
Typeidstring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
4. Patient.meta
Definition

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

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

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

ShortVersion specific identifier
Comments

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

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

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

ShortWhen the resource version last changed
Comments

Represents the date of last update of this resource. This field is always supplied upon read or query. It will be automatically computed upon a create or update.


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

Control10..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Patient.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.

Control20..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Patient.meta.profile. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ uri
  • 12. Patient.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

    The Argonaut implementation guide requires use of the Data Access Framework profile for the Patient Resource.


    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.

    Control10..1*
    Typecanonical(StructureDefinition)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Fixed Valuehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Patient.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

    The Athena Patient Profile defines the capabilities of the Patient Resource supported by GE Centricity products.


    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.

    Control10..1*
    Typecanonical(StructureDefinition)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Patient.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

    If the patient's chart is tagged as being sensitive, then it will contain a security tag that indicates that this chart is restricted, otherwise it will contain a security tag indicating that it requires normal security.


    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..1*
    BindingUnless not suitable, these codes SHALL be taken from All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels
    (extensible to http://hl7.org/fhir/ValueSet/security-labels)

    Security Labels from the Healthcare Privacy and Security Classification System.

    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. Patient.implicitRules
    Definition

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

    ShortA set of rules under which this content was created
    Comments

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

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

    Mother's maiden (unmarried) name, commonly collected to help verify patient identity.

    ShortMother's Maiden name
    Control0..1
    TypeExtension(Patient Mother's Maiden Name) (Extension Type: string)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. Patient.extension:mothersMaidenName.extension
    Definition

    An Extension


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

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..0*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 24. Patient.extension:mothersMaidenName.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
      26. Patient.extension:mothersMaidenName.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).


      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      This element is affected by the following invariants: ext-1
      Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Patient.extension:RESPPROVID
      Slice NameRESPPROVID
      Definition

      Responsible Provider ID.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(RESPPROVID) (Extension Type: Reference)
      Is Modifierfalse
      Must Supportfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      30. Patient.extension:RESPPROVID.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID
      32. Patient.extension:RESPPROVID.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeReference(Practitioner), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. Patient.extension:REFDOCID
      Slice NameREFDOCID
      Definition

      Reference Doctor ID.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(REFDOCID) (Extension Type: Reference)
      Is Modifierfalse
      Must Supportfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      36. Patient.extension:REFDOCID.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID
      38. Patient.extension:REFDOCID.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeReference(Practitioner), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Patient.extension:preferredContact
      Slice NamepreferredContact
      Definition

      Preferred Contact of the Patient.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(prefferedContact) (Extension Type: string)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      42. Patient.extension:preferredContact.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact
      44. Patient.extension:preferredContact.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Patient.extension:BIRTHTIME
      Slice NameBIRTHTIME
      Definition

      An Extension

      ShortExtension
      Control0..1
      TypeExtension(https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      48. Patient.extension:BIRTHTIME.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime
      50. Patient.extension:BIRTHTIME.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypedateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. Patient.extension:patientAsGuarantor
      Slice NamepatientAsGuarantor
      Definition

      patient as guarantor.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(patientAsGuarantor) (Extension Type: boolean)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      54. Patient.extension:patientAsGuarantor.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor
      56. Patient.extension:patientAsGuarantor.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      58. Patient.extension:genderIdentity
      Slice NamegenderIdentity
      Definition

      Gender Identity.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(genderIdentity) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      60. Patient.extension:genderIdentity.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
      62. Patient.extension:genderIdentity.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      64. Patient.extension:sexualOrientation
      Slice NamesexualOrientation
      Definition

      Sexual Orientation.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(sexualOrientation) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      66. Patient.extension:sexualOrientation.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation
      68. Patient.extension:sexualOrientation.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      70. Patient.extension:guarantorDetails
      Slice NameguarantorDetails
      Definition

      Guarantor Id.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(guarantorDetails) (Extension Type: Reference)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      72. Patient.extension:guarantorDetails.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails
      74. Patient.extension:guarantorDetails.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeReference(RelatedPerson), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      76. Patient.extension:USCORERACE
      Slice NameUSCORERACE
      Definition

      Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

      • American Indian or Alaska Native
      • Asian
      • Black or African American
      • Native Hawaiian or Other Pacific Islander
      • White.
      ShortUS Core Race Extension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(US Core Race Extension) (Complex Extension)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      78. Patient.extension:USCOREETHNICITY
      Slice NameUSCOREETHNICITY
      Definition

      Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

      ShortUS Core ethnicity Extension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(US Core Ethnicity Extension) (Complex Extension)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      80. Patient.extension:USCOREBIRTHSEX
      Slice NameUSCOREBIRTHSEX
      Definition

      A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

      ShortExtension
      Comments

      The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(US Core Birth Sex Extension) (Extension Type: code)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      82. Patient.extension:USCORESEX
      Slice NameUSCORESEX
      Definition

      An Extension

      ShortExtension
      Control0..1
      TypeExtension(http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      84. Patient.extension:PATIENTEDUCATUION
      Slice NamePATIENTEDUCATUION
      Definition

      An Extension

      ShortExtension
      Control0..1
      TypeExtension(https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      86. Patient.extension:OCCUPATION
      Slice NameOCCUPATION
      Definition

      Occupation.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(occupation) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      88. Patient.extension:OCCUPATION.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation
      90. Patient.extension:OCCUPATION.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      92. Patient.extension:OCCUPATIONINDUSTRY
      Slice NameOCCUPATIONINDUSTRY
      Definition

      occupationIndustry.

      ShortExtension
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(occupationIndustry) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      94. Patient.extension:OCCUPATIONINDUSTRY.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry
      96. Patient.extension:OCCUPATIONINDUSTRY.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      98. Patient.extension:TRIBALAFFILIATION
      Slice NameTRIBALAFFILIATION
      Definition

      An Extension

      ShortExtension
      Control0..1
      TypeExtension(http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      100. Patient.extension:PRONOUN
      Slice NamePRONOUN
      Definition

      An Extension

      ShortExtension
      Control0..1
      TypeExtension(http://terminology.hl7.org/ValueSet/pronouns)
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      102. Patient.extension:PRONOUN.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://terminology.hl7.org/ValueSet/pronouns
      104. Patient.extension:PRONOUN.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortValue of extension
      Control10..1
      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      106. Patient.modifierExtension
      Definition

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

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

      ShortExtensions that cannot be ignored
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Summaryfalse
      Requirements

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

      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      108. Patient.identifier
      Definition

      An identifier for this patient.

      ShortAn identifier for this patient
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control10..*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Patients are almost always assigned specific numerical identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ type
      • 110. Patient.identifier
        Definition

        An identifier for this patient.

        ShortAn identifier for this patient
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1*
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

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

        The purpose of this identifier.

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

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

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

        Identifies the purpose for this identifier, if known .

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

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

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

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

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

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

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

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

        A reference to a code defined by a terminology system.

        ShortCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control10..1*
        TypeCoding
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

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

        The identification of the code system that defines the meaning of the symbol in the code.

        ShortIdentity of the terminology system
        Comments

        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

        Need to be unambiguous about the source of the definition of the symbol.

        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        120. Patient.identifier.type.coding.code
        Definition

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        ShortSymbol in syntax defined by the system
        Control10..1
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

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

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

        ShortThe namespace for the identifier value
        Comments

        Identifier.system is always case sensitive.

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

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

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

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

        ShortThe value that is unique
        Comments

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

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

        An identifier for this patient.

        ShortAn identifier for this patient
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1*
        TypeIdentifier
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

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

        The purpose of this identifier.

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

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

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

        Identifies the purpose for this identifier, if known .

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

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

        Fixed Valuesecondary
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        130. Patient.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 Codeshttp://hl7.org/fhir/ValueSet/identifier-type
        (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

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

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

        A reference to a code defined by a terminology system.

        ShortCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control10..1*
        TypeCoding
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

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

        The identification of the code system that defines the meaning of the symbol in the code.

        ShortIdentity of the terminology system
        Comments

        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

        Need to be unambiguous about the source of the definition of the symbol.

        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        136. Patient.identifier.type.coding.code
        Definition

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        ShortSymbol in syntax defined by the system
        Control10..1
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

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

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

        ShortThe namespace for the identifier value
        Comments

        Identifier.system is always case sensitive.

        Control10..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        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.

        Fixed Valuehttp://hl7.org/fhir/sid/us-ssn
        Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        140. Patient.identifier.value
        Definition

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

        ShortThe value that is unique
        Comments

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

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

        An identifier for this patient.

        ShortAn identifier for this patient
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1*
        TypeIdentifier
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

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

        The purpose of this identifier.

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

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

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

        Identifies the purpose for this identifier, if known .

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

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        146. Patient.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 Codeshttp://hl7.org/fhir/ValueSet/identifier-type
        (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

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

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

        A reference to a code defined by a terminology system.

        ShortCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control10..1*
        TypeCoding
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

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

        The identification of the code system that defines the meaning of the symbol in the code.

        ShortIdentity of the terminology system
        Comments

        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

        Need to be unambiguous about the source of the definition of the symbol.

        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        152. Patient.identifier.type.coding.code
        Definition

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        ShortSymbol in syntax defined by the system
        Control10..1
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

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

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

        ShortThe namespace for the identifier value
        Comments

        Identifier.system is always case sensitive.

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

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

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

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

        ShortThe value that is unique
        Comments

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

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

        An identifier for this patient.

        ShortAn identifier for this patient
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

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

        Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

        It is often used to filter patient lists to exclude inactive patients

        Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

        ShortWhether this patient's record is in active use
        Comments

        If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

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

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

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

        A name associated with the individual.

        ShortA name associated with the patient
        Comments

        A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

        Control10..*
        TypeHumanName
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ use
        • 164. Patient.name:Name
          Slice NameName
          Definition

          A name associated with the individual.

          ShortA name associated with the patient
          Comments

          A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

          Control10..1*
          TypeHumanName
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          166. Patient.name:Name.use
          Definition

          Identifies the purpose for this name.

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

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

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

          The use of a human name.

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

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

          Fixed Valueofficial
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          168. Patient.name:Name.family
          Definition

          The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

          ShortFamily name (often called 'Surname')
          Comments

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

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

          Given name.

          ShortGiven names (not always 'first'). Includes middle names
          Comments

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

          Control0..2*
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Alternate Namesfirst name, middle name
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Patient.name.given. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ given
          • 172. Patient.name:Name.given:First Name
            Slice NameFirst Name
            Definition

            Given name.

            ShortGiven names (not always 'first'). Includes middle names
            Comments

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

            Control0..1*
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Alternate Namesfirst name, middle name
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            174. Patient.name:Name.given:Middle Name
            Slice NameMiddle Name
            Definition

            Given name.

            ShortGiven names (not always 'first'). Includes middle names
            Comments

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

            Control0..1*
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Alternate Namesfirst name, middle name
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            176. Patient.name: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..1*
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            178. Patient.name: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..1*
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            180. Patient.name:PreviousName
            Slice NamePreviousName
            Definition

            A name associated with the individual.

            ShortA name associated with the patient
            Comments

            A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

            Control0..1*
            TypeHumanName
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

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

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            182. Patient.name:PreviousName.use
            Definition

            Identifies the purpose for this name.

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

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

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

            The use of a human name.

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

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

            Fixed Valueold
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            184. Patient.name:PreviousName.family
            Definition

            The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

            ShortFamily name (often called 'Surname')
            Comments

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

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

            Given name.

            ShortGiven names (not always 'first'). Includes middle names
            Comments

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

            Control0..1*
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Alternate Namesfirst name, middle name
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Patient.name.given. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ given
            • 188. Patient.name:PreviousName.given:Previous First Name
              Slice NamePrevious First Name
              Definition

              Given name.

              ShortGiven names (not always 'first'). Includes middle names
              Comments

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

              Control0..1*
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summarytrue
              Alternate Namesfirst name, middle name
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              190. Patient.name:PreviousName.given:Previous Middle Name
              Slice NamePrevious Middle Name
              Definition

              Given name.

              ShortGiven names (not always 'first'). Includes middle names
              Comments

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

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

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

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

              Allows names to be placed in historical context.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              196. Patient.name:Nickname
              Slice NameNickname
              Definition

              A name associated with the individual.

              ShortA name associated with the patient
              Comments

              A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

              Control0..1*
              TypeHumanName
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              198. Patient.name:Nickname.use
              Definition

              Identifies the purpose for this name.

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

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

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

              The use of a human name.

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

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              200. Patient.name:Nickname.given
              Definition

              Given name.

              ShortGiven names (not always 'first'). Includes middle names
              Comments

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

              Control0..1*
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summarytrue
              Alternate Namesfirst name, middle name
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              202. Patient.telecom
              Definition

              A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

              ShortA contact detail for the individual
              Comments

              A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

              Control0..6*
              TypeContactPoint
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Requirements

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ use
              • 204. Patient.telecom:Work
                Slice NameWork
                Definition

                A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                ShortA contact detail for the individual
                Comments

                A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                Control0..1*
                TypeContactPoint
                Is Modifierfalse
                Must Supportfalse
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                206. Patient.telecom:Work.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
                Control10..1
                This element is affected by the following invariants: cpt-2
                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                Telecommunications form for contact point.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Fixed Valuephone
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                208. Patient.telecom:Work.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.

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

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

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

                Identifies the purpose for the contact point.

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

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

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

                Use of contact point.

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

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

                Fixed Valuework
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                212. Patient.telecom:Home
                Slice NameHome
                Definition

                A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                ShortA contact detail for the individual
                Comments

                A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                Control0..1*
                TypeContactPoint
                Is Modifierfalse
                Must Supportfalse
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                214. Patient.telecom:Home.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
                Control10..1
                This element is affected by the following invariants: cpt-2
                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                Telecommunications form for contact point.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Fixed Valuephone
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                216. Patient.telecom:Home.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.

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

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

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

                Identifies the purpose for the contact point.

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

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

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

                Use of contact point.

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

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

                Fixed Valuehome
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                220. Patient.telecom:Mobile
                Slice NameMobile
                Definition

                A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                ShortA contact detail for the individual
                Comments

                A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                Control0..1*
                TypeContactPoint
                Is Modifierfalse
                Must Supportfalse
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                222. Patient.telecom:Mobile.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
                Control10..1
                This element is affected by the following invariants: cpt-2
                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                Telecommunications form for contact point.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Fixed Valuephone
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                224. Patient.telecom:Mobile.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.

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

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

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

                Identifies the purpose for the contact point.

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

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

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

                Use of contact point.

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

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

                Fixed Valuemobile
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                228. Patient.telecom:Fax
                Slice NameFax
                Definition

                A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                ShortA contact detail for the individual
                Comments

                A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                Control0..1*
                TypeContactPoint
                Is Modifierfalse
                Must Supportfalse
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                230. Patient.telecom:Fax.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
                Control10..1
                This element is affected by the following invariants: cpt-2
                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                Telecommunications form for contact point.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Fixed Valuefax
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                232. Patient.telecom:Fax.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.

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

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

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

                Identifies the purpose for the contact point.

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

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

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

                Use of contact point.

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

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                236. Patient.telecom:Pager
                Slice NamePager
                Definition

                A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                ShortA contact detail for the individual
                Comments

                A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                Control0..1*
                TypeContactPoint
                Is Modifierfalse
                Must Supportfalse
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                238. Patient.telecom:Pager.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
                Control10..1
                This element is affected by the following invariants: cpt-2
                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                Telecommunications form for contact point.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Fixed Valuepager
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                240. Patient.telecom:Pager.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.

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

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

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

                Identifies the purpose for the contact point.

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

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

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

                Use of contact point.

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

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                244. Patient.telecom:Email
                Slice NameEmail
                Definition

                A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                ShortA contact detail for the individual
                Comments

                A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                Control0..1*
                TypeContactPoint
                Is Modifierfalse
                Must Supportfalse
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                246. Patient.telecom:Email.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
                Control10..1
                This element is affected by the following invariants: cpt-2
                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                Telecommunications form for contact point.

                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Fixed Valueemail
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                248. Patient.telecom:Email.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.

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

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

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

                Identifies the purpose for the contact point.

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

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

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

                Use of contact point.

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

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

                Fixed Valuehome
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                252. Patient.gender
                Definition

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

                Shortmale | female | other | unknown
                Comments

                The gender might 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 male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

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

                The gender of a person used for administrative purposes.

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

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

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

                The date of birth for the individual.

                ShortThe date of birth for the individual
                Comments

                At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

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

                Age of the individual drives many clinical processes.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                LOINC Code21112-8
                256. Patient.deceased[x]
                Definition

                Indicates if the individual is deceased or not.

                ShortIndicates if the individual is deceased or not
                Comments

                If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                Control0..1
                TypeChoice of: boolean, dateTime
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Must Support TypesNo must-support rules about the choice of types/profiles
                Summarytrue
                Requirements

                The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

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

                An address for the individual.

                ShortAn address for the individual
                Comments

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

                Control10..*
                TypeAddress
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ use
                • 260. Patient.address:Current Address
                  Slice NameCurrent Address
                  Definition

                  An address for the individual.

                  ShortAn address for the individual
                  Comments

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

                  Control0..1*
                  TypeAddress
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

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

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  262. Patient.address:Current Address.use
                  Definition

                  The purpose of this address.

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

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

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

                  The use of an address.

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

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

                  Fixed Valuehome
                  Example<br/><b>General</b>:home
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  264. Patient.address:Current 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..2*
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Example<br/><b>General</b>:137 Nowhere Street
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on Patient.address.line. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ line
                  • 266. Patient.address:Current 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..1*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summarytrue
                    Example<br/><b>General</b>:137 Nowhere Street
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    268. Patient.address:Current 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..1*
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summarytrue
                    Example<br/><b>General</b>:137 Nowhere Street
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    270. Patient.address:Current Address.city
                    Definition

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

                    ShortName of city, town etc.
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summarytrue
                    Alternate NamesMunicpality
                    Example<br/><b>General</b>:Erewhon
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    272. Patient.address:Current Address.state
                    Definition

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

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

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

                    ShortPostal code for area
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summarytrue
                    Alternate NamesZip
                    Example<br/><b>General</b>:9132
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    276. Patient.address:Current Address.country
                    Definition

                    Country - a nation as commonly understood or generally accepted.

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

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

                    Control0..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    278. Patient.address:Previous Address
                    Slice NamePrevious Address
                    Definition

                    An address for the individual.

                    ShortAn address for the individual
                    Comments

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

                    Control0..*
                    TypeAddress
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

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

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

                    This field contains a patient's most recent marital (civil) status.

                    ShortMarital (civil) status of a patient
                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status
                    (extensible to http://hl7.org/fhir/ValueSet/marital-status)

                    The domestic partnership status of a person.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summaryfalse
                    Requirements

                    Most, if not all systems capture it.

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

                    Image of the patient.

                    ShortImage of the patient
                    Comments

                    Guidelines:

                    • Use id photos, not clinical photos.
                    • Limit dimensions to thumbnail.
                    • Keep byte count low to ease resource updates.
                    Control0..*
                    TypeAttachment
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

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

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

                    A contact party (e.g. guardian, partner, friend) for the patient.

                    ShortA contact party (e.g. guardian, partner, friend) for the patient
                    Comments

                    Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

                    Need to track people you can contact about the patient.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                    pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                    286. Patient.contact.modifierExtension
                    Definition

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    288. Patient.contact.relationship
                    Definition

                    The nature of the relationship between the patient and the contact person.

                    ShortThe kind of relationship
                    Control0..*
                    BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship
                    (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                    The nature of the relationship between a patient and a contact person for that patient.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

                    Used to determine which contact person is the most relevant to approach, depending on circumstances.

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

                    A name associated with the contact person.

                    ShortA name associated with the contact person
                    Control0..1
                    TypeHumanName
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

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

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

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

                    ShortA contact detail for the person
                    Comments

                    Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                    Control0..*
                    TypeContactPoint
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

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

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

                    Address for the contact person.

                    ShortAddress for the contact person
                    Control0..1
                    TypeAddress
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

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

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

                    A language which may be used to communicate with the patient about his or her health.

                    ShortA language which may be used to communicate with the patient about his or her health
                    Comments

                    If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.


                    If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

                    If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

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

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

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    300. Patient.communication.language
                    Definition

                    The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

                    ShortThe language which can be used to communicate with the patient about his or her health
                    Comments

                    The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

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

                    A human language.

                    Additional BindingsPurpose
                    AllLanguagesMax Binding
                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Requirements

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

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

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

                    ShortLanguage preference indicator
                    Comments

                    This language is specifically identified for communicating healthcare information.

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

                    People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

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

                    Patient's nominated care provider.

                    ShortPatient's nominated primary care provider
                    Comments

                    This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. This is not to be used to record Care Teams, these should be recorded on either the CarePlan or EpisodeOfCare resources.


                    This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                    Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                    Control0..*
                    TypeReference(Practitioner, Organization, PractitionerRole)
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Alternate NamescareProvider
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    306. Patient.managingOrganization
                    Definition

                    Organization that is the custodian of the patient record.

                    ShortOrganization that is the custodian of the patient record
                    Comments

                    There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Requirements

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

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

                    Link to another patient resource that concerns the same actual patient.

                    ShortLink to another patient resource that concerns the same actual person
                    Comments

                    There is no assumption that linked patient records have mutual links.

                    Control0..*
                    TypeBackboneElement
                    Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                    Summarytrue
                    Requirements

                    There are multiple use cases:

                    • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                    • Distribution of patient information across multiple servers.
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    310. Patient.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

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

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    312. Patient.link.other
                    Definition

                    The other patient resource that the link refers to.

                    ShortThe other patient or related person resource that the link refers to
                    Comments

                    Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                    Control1..1
                    TypeReference(Patient, RelatedPerson)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    314. Patient.link.type
                    Definition

                    The type of link between this patient resource and another patient resource.

                    Shortreplaced-by | replaces | refer | seealso
                    Control1..1
                    BindingThe codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1
                    (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                    The type of link between this patient resource and another patient resource.

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

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

                    0. Patient
                    Must Supportfalse
                    Alternate NamesSubjectOfCare Client Resident
                    2. Patient.id
                    Control0..1
                    Typeid
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    4. Patient.meta
                    Control0..1
                    TypeMeta
                    Must Supportfalse
                    6. Patient.meta.versionId
                    Control0..1
                    Typeid
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    8. Patient.meta.lastUpdated
                    Comments

                    Represents the date of last update of this resource. This field is always supplied upon read or query. It will be automatically computed upon a create or update.

                    Control1..1
                    Typeinstant
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    10. Patient.meta.profile
                    Control2..*
                    Typecanonical
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    SlicingThis element introduces a set of slices on Patient.meta.profile. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ uri
                    • 12. Patient.meta.profile
                      Comments

                      The Argonaut implementation guide requires use of the Data Access Framework profile for the Patient Resource.

                      Control1..1
                      Typecanonical
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
                      14. Patient.meta.profile
                      Comments

                      The Athena Patient Profile defines the capabilities of the Patient Resource supported by GE Centricity products.

                      Control1..1
                      Typecanonical
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile
                      16. Patient.meta.security
                      Comments

                      If the patient's chart is tagged as being sensitive, then it will contain a security tag that indicates that this chart is restricted, otherwise it will contain a security tag indicating that it requires normal security.

                      Control0..1
                      TypeCoding
                      Must Supporttrue
                      18. Patient.extension:mothersMaidenName
                      Slice NamemothersMaidenName
                      Control0..1
                      TypeExtension(Patient Mother's Maiden Name) (Extension Type: string)
                      Must Supporttrue
                      20. Patient.extension:mothersMaidenName.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
                      22. Patient.extension:mothersMaidenName.value[x]
                      Control1..1
                      Typestring
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      24. Patient.extension:RESPPROVID
                      Slice NameRESPPROVID
                      Control0..1
                      TypeExtension(RESPPROVID) (Extension Type: Reference)
                      Must Supportfalse
                      26. Patient.extension:RESPPROVID.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID
                      28. Patient.extension:RESPPROVID.value[x]
                      Control1..1
                      TypeReference(Practitioner)
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      30. Patient.extension:REFDOCID
                      Slice NameREFDOCID
                      Control0..1
                      TypeExtension(REFDOCID) (Extension Type: Reference)
                      Must Supportfalse
                      32. Patient.extension:REFDOCID.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID
                      34. Patient.extension:REFDOCID.value[x]
                      Control1..1
                      TypeReference(Practitioner)
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      36. Patient.extension:preferredContact
                      Slice NamepreferredContact
                      Control0..1
                      TypeExtension(prefferedContact) (Extension Type: string)
                      Must Supporttrue
                      38. Patient.extension:preferredContact.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact
                      40. Patient.extension:preferredContact.value[x]
                      Control1..1
                      Typestring
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      42. Patient.extension:BIRTHTIME
                      Slice NameBIRTHTIME
                      Control0..1
                      TypeExtension(https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime)
                      Must Supporttrue
                      44. Patient.extension:BIRTHTIME.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime
                      46. Patient.extension:BIRTHTIME.value[x]
                      Control1..1
                      TypedateTime
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      48. Patient.extension:patientAsGuarantor
                      Slice NamepatientAsGuarantor
                      Control0..1
                      TypeExtension(patientAsGuarantor) (Extension Type: boolean)
                      Must Supporttrue
                      50. Patient.extension:patientAsGuarantor.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor
                      52. Patient.extension:patientAsGuarantor.value[x]
                      Control1..1
                      Typeboolean
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      54. Patient.extension:genderIdentity
                      Slice NamegenderIdentity
                      Control0..1
                      TypeExtension(genderIdentity) (Extension Type: CodeableConcept)
                      Must Supporttrue
                      56. Patient.extension:genderIdentity.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
                      58. Patient.extension:genderIdentity.value[x]
                      Control1..1
                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      60. Patient.extension:sexualOrientation
                      Slice NamesexualOrientation
                      Control0..1
                      TypeExtension(sexualOrientation) (Extension Type: CodeableConcept)
                      Must Supporttrue
                      62. Patient.extension:sexualOrientation.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation
                      64. Patient.extension:sexualOrientation.value[x]
                      Control1..1
                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      66. Patient.extension:guarantorDetails
                      Slice NameguarantorDetails
                      Control0..1
                      TypeExtension(guarantorDetails) (Extension Type: Reference)
                      Must Supporttrue
                      68. Patient.extension:guarantorDetails.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails
                      70. Patient.extension:guarantorDetails.value[x]
                      Control1..1
                      TypeReference(RelatedPerson)
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      72. Patient.extension:USCORERACE
                      Slice NameUSCORERACE
                      Control0..1
                      TypeExtension(US Core Race Extension) (Complex Extension)
                      Must Supporttrue
                      74. Patient.extension:USCOREETHNICITY
                      Slice NameUSCOREETHNICITY
                      Control0..1
                      TypeExtension(US Core Ethnicity Extension) (Complex Extension)
                      Must Supporttrue
                      76. Patient.extension:USCOREBIRTHSEX
                      Slice NameUSCOREBIRTHSEX
                      Control0..1
                      TypeExtension(US Core Birth Sex Extension) (Extension Type: code)
                      Must Supporttrue
                      78. Patient.extension:USCORESEX
                      Slice NameUSCORESEX
                      Control0..1
                      TypeExtension(http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex)
                      Must Supporttrue
                      80. Patient.extension:PATIENTEDUCATUION
                      Slice NamePATIENTEDUCATUION
                      Control0..1
                      TypeExtension(https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided)
                      Must Supporttrue
                      82. Patient.extension:OCCUPATION
                      Slice NameOCCUPATION
                      Control0..1
                      TypeExtension(occupation) (Extension Type: CodeableConcept)
                      Must Supporttrue
                      84. Patient.extension:OCCUPATION.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation
                      86. Patient.extension:OCCUPATION.value[x]
                      Control1..1
                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      88. Patient.extension:OCCUPATIONINDUSTRY
                      Slice NameOCCUPATIONINDUSTRY
                      Control0..1
                      TypeExtension(occupationIndustry) (Extension Type: CodeableConcept)
                      Must Supporttrue
                      90. Patient.extension:OCCUPATIONINDUSTRY.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry
                      92. Patient.extension:OCCUPATIONINDUSTRY.value[x]
                      Control1..1
                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      94. Patient.extension:TRIBALAFFILIATION
                      Slice NameTRIBALAFFILIATION
                      Control0..1
                      TypeExtension(http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation)
                      Must Supporttrue
                      96. Patient.extension:PRONOUN
                      Slice NamePRONOUN
                      Control0..1
                      TypeExtension(http://terminology.hl7.org/ValueSet/pronouns)
                      Must Supportfalse
                      98. Patient.extension:PRONOUN.url
                      Control1..1
                      Typeuri
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Fixed Valuehttp://terminology.hl7.org/ValueSet/pronouns
                      100. Patient.extension:PRONOUN.value[x]
                      Control1..1
                      TypeCodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Must Supportfalse
                      102. Patient.identifier
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control1..*
                      TypeIdentifier
                      Must Supporttrue
                      SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ type
                      • 104. Patient.identifier
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        TypeIdentifier
                        Must Supporttrue
                        106. Patient.identifier.type
                        Control1..1
                        TypeCodeableConcept
                        Must Supporttrue
                        108. Patient.identifier.type.coding
                        Control1..1
                        TypeCoding
                        Must Supportfalse
                        110. Patient.identifier.type.coding.system
                        Control1..1
                        Typeuri
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                        112. Patient.identifier.type.coding.code
                        Control1..1
                        Typecode
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Fixed ValuePI
                        114. Patient.identifier.system
                        Control1..1
                        Typeuri
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        116. Patient.identifier.value
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        118. Patient.identifier
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        TypeIdentifier
                        Must Supportfalse
                        120. Patient.identifier.use
                        Control1..1
                        Typecode
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Fixed Valuesecondary
                        122. Patient.identifier.type
                        Control0..1
                        TypeCodeableConcept
                        Must Supporttrue
                        124. Patient.identifier.type.coding
                        Control1..1
                        TypeCoding
                        Must Supportfalse
                        126. Patient.identifier.type.coding.system
                        Control1..1
                        Typeuri
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                        128. Patient.identifier.type.coding.code
                        Control1..1
                        Typecode
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Fixed ValueSB
                        130. Patient.identifier.system
                        Control1..1
                        Typeuri
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Fixed Valuehttp://hl7.org/fhir/sid/us-ssn
                        132. Patient.identifier.value
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        134. Patient.identifier
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        TypeIdentifier
                        Must Supportfalse
                        136. Patient.identifier.type
                        Control0..1
                        TypeCodeableConcept
                        Must Supporttrue
                        138. Patient.identifier.type.coding
                        Control1..1
                        TypeCoding
                        Must Supportfalse
                        140. Patient.identifier.type.coding.system
                        Control1..1
                        Typeuri
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                        142. Patient.identifier.type.coding.code
                        Control1..1
                        Typecode
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Fixed ValueMR
                        144. Patient.identifier.system
                        Control1..1
                        Typeuri
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        146. Patient.identifier.value
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        148. Patient.identifier
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..*
                        TypeIdentifier
                        Must Supportfalse
                        150. Patient.active
                        Control0..1
                        Typeboolean
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        152. Patient.name
                        Control1..*
                        TypeHumanName
                        Must Supporttrue
                        SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ use
                        • 154. Patient.name:Name
                          Slice NameName
                          Control1..1
                          TypeHumanName
                          Must Supporttrue
                          156. Patient.name:Name.use
                          Control0..1
                          Typecode
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          Fixed Valueofficial
                          158. Patient.name:Name.family
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          160. Patient.name:Name.given
                          Control0..2
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          SlicingThis element introduces a set of slices on Patient.name.given. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ given
                          • 162. Patient.name:Name.given:First Name
                            Slice NameFirst Name
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            164. Patient.name:Name.given:Middle Name
                            Slice NameMiddle Name
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            166. Patient.name:Name.prefix
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            168. Patient.name:Name.suffix
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            170. Patient.name:PreviousName
                            Slice NamePreviousName
                            Control0..1
                            TypeHumanName
                            Must Supporttrue
                            172. Patient.name:PreviousName.use
                            Control0..1
                            Typecode
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Fixed Valueold
                            174. Patient.name:PreviousName.family
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            176. Patient.name:PreviousName.given
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            SlicingThis element introduces a set of slices on Patient.name.given. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ given
                            • 178. Patient.name:PreviousName.given:Previous First Name
                              Slice NamePrevious First Name
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              180. Patient.name:PreviousName.given:Previous Middle Name
                              Slice NamePrevious Middle Name
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              182. Patient.name:PreviousName.suffix
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              184. Patient.name:PreviousName.period
                              Control0..1
                              TypePeriod
                              Must Supportfalse
                              186. Patient.name:Nickname
                              Slice NameNickname
                              Control0..1
                              TypeHumanName
                              Must Supportfalse
                              188. Patient.name:Nickname.use
                              Control0..1
                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              190. Patient.name:Nickname.given
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              192. Patient.telecom
                              Control0..6
                              TypeContactPoint
                              Must Supportfalse
                              SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ use
                              • 194. Patient.telecom:Work
                                Slice NameWork
                                Control0..1
                                TypeContactPoint
                                Must Supportfalse
                                196. Patient.telecom:Work.system
                                Control1..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuephone
                                198. Patient.telecom:Work.value
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                200. Patient.telecom:Work.use
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuework
                                202. Patient.telecom:Home
                                Slice NameHome
                                Control0..1
                                TypeContactPoint
                                Must Supportfalse
                                204. Patient.telecom:Home.system
                                Control1..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuephone
                                206. Patient.telecom:Home.value
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                208. Patient.telecom:Home.use
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuehome
                                210. Patient.telecom:Mobile
                                Slice NameMobile
                                Control0..1
                                TypeContactPoint
                                Must Supportfalse
                                212. Patient.telecom:Mobile.system
                                Control1..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuephone
                                214. Patient.telecom:Mobile.value
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                216. Patient.telecom:Mobile.use
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuemobile
                                218. Patient.telecom:Fax
                                Slice NameFax
                                Control0..1
                                TypeContactPoint
                                Must Supportfalse
                                220. Patient.telecom:Fax.system
                                Control1..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuefax
                                222. Patient.telecom:Fax.value
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                224. Patient.telecom:Fax.use
                                Control0..0
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                226. Patient.telecom:Pager
                                Slice NamePager
                                Control0..1
                                TypeContactPoint
                                Must Supportfalse
                                228. Patient.telecom:Pager.system
                                Control1..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuepager
                                230. Patient.telecom:Pager.value
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                232. Patient.telecom:Email
                                Slice NameEmail
                                Control0..1
                                TypeContactPoint
                                Must Supportfalse
                                234. Patient.telecom:Email.system
                                Control1..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valueemail
                                236. Patient.telecom:Email.value
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                238. Patient.telecom:Email.use
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Fixed Valuehome
                                240. Patient.gender
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                242. Patient.birthDate
                                Control0..1
                                Typedate
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                LOINC Code
                                244. Patient.deceased[x]
                                Control0..1
                                TypeChoice of: boolean, dateTime
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Must Support TypesNo must-support rules about the choice of types/profiles
                                246. Patient.address
                                Control1..*
                                TypeAddress
                                Must Supporttrue
                                SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ use
                                • 248. Patient.address:Current Address
                                  Slice NameCurrent Address
                                  Control0..1
                                  TypeAddress
                                  Must Supporttrue
                                  250. Patient.address:Current Address.use
                                  Control0..1
                                  Typecode
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supportfalse
                                  Fixed Valuehome
                                  252. Patient.address:Current Address.line
                                  Control0..2
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supportfalse
                                  SlicingThis element introduces a set of slices on Patient.address.line. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ line
                                  • 254. Patient.address:Current Address.line
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    256. Patient.address:Current Address.line
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    258. Patient.address:Current Address.city
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    260. Patient.address:Current Address.state
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    262. Patient.address:Current Address.postalCode
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    264. Patient.address:Current Address.country
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    266. Patient.address:Previous Address
                                    Slice NamePrevious Address
                                    Control0..*
                                    TypeAddress
                                    Must Supporttrue
                                    268. Patient.maritalStatus
                                    Control0..1
                                    TypeCodeableConcept
                                    Must Supporttrue
                                    270. Patient.photo
                                    Control0..*
                                    TypeAttachment
                                    Must Supportfalse
                                    272. Patient.contact
                                    Control0..*
                                    TypeBackboneElement
                                    Must Supportfalse
                                    274. Patient.contact.relationship
                                    Control0..*
                                    TypeCodeableConcept
                                    Must Supportfalse
                                    276. Patient.contact.name
                                    Control0..1
                                    TypeHumanName
                                    Must Supportfalse
                                    278. Patient.contact.telecom
                                    Control0..*
                                    TypeContactPoint
                                    Must Supportfalse
                                    280. Patient.contact.address
                                    Control0..1
                                    TypeAddress
                                    Must Supportfalse
                                    282. Patient.communication
                                    Comments

                                    If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                    Control0..*
                                    Must Supportfalse
                                    284. Patient.communication.language
                                    Comments

                                    The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

                                    Control1..1
                                    TypeCodeableConcept
                                    Must Supportfalse
                                    286. Patient.communication.preferred
                                    Comments

                                    This language is specifically identified for communicating healthcare information.

                                    Control0..1
                                    Typeboolean
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    288. Patient.generalPractitioner
                                    Comments

                                    This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. This is not to be used to record Care Teams, these should be recorded on either the CarePlan or EpisodeOfCare resources.

                                    Control0..*
                                    TypeReference(Practitioner)
                                    Must Supportfalse
                                    290. Patient.managingOrganization
                                    Comments

                                    There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                    Control0..1
                                    TypeReference(Organization)
                                    Must Supportfalse

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

                                    0. Patient
                                    Definition

                                    Demographics and other administrative information about an individual or animal receiving care or other health-related services.

                                    ShortInformation about an individual or animal receiving health care services
                                    Control0..*
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summaryfalse
                                    Alternate NamesSubjectOfCare Client Resident
                                    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                                    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                                    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                    dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                    2. Patient.id
                                    Definition

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

                                    ShortLogical id of this artifact
                                    Comments

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

                                    Control0..1
                                    Typeid
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supportfalse
                                    Summarytrue
                                    4. Patient.meta
                                    Definition

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

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

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

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

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

                                    ShortAdditional content defined by implementations
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    SlicingThis element introduces a set of slices on Patient.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 10. Patient.meta.versionId
                                      Definition

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

                                      ShortVersion specific identifier
                                      Comments

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

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

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

                                      ShortWhen the resource version last changed
                                      Comments

                                      Represents the date of last update of this resource. This field is always supplied upon read or query. It will be automatically computed upon a create or update.

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

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

                                      ShortIdentifies where the resource comes from
                                      Comments

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

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

                                      Control0..1
                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      16. Patient.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.

                                      Control2..*
                                      Typecanonical
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      SlicingThis element introduces a set of slices on Patient.meta.profile. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ uri
                                      • 18. Patient.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

                                        The Argonaut implementation guide requires use of the Data Access Framework profile for the Patient Resource.

                                        Control1..1
                                        Typecanonical
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supportfalse
                                        Summarytrue
                                        Fixed Valuehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        20. Patient.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

                                        The Athena Patient Profile defines the capabilities of the Patient Resource supported by GE Centricity products.

                                        Control1..1
                                        Typecanonical
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supportfalse
                                        Summarytrue
                                        Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        22. Patient.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

                                        If the patient's chart is tagged as being sensitive, then it will contain a security tag that indicates that this chart is restricted, otherwise it will contain a security tag indicating that it requires normal security.

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

                                        Security Labels from the Healthcare Privacy and Security Classification System.

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

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

                                        ShortTags applied to this resource
                                        Comments

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

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

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

                                        TypeCoding
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        26. Patient.implicitRules
                                        Definition

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

                                        ShortA set of rules under which this content was created
                                        Comments

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

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

                                        The base language in which the resource is written.

                                        ShortLanguage of the resource content
                                        Comments

                                        Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

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

                                        A human language.

                                        Additional BindingsPurpose
                                        AllLanguagesMax Binding
                                        Typecode
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        30. Patient.text
                                        Definition

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

                                        ShortText summary of the resource, for human interpretation
                                        Comments

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

                                        Control0..1
                                        TypeNarrative
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesnarrative, html, xhtml, display
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        32. Patient.contained
                                        Definition

                                        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                        ShortContained, inline Resources
                                        Comments

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

                                        Control0..*
                                        TypeResource
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesinline resources, anonymous resources, contained resources
                                        34. Patient.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 36. Patient.extension:mothersMaidenName
                                          Slice NamemothersMaidenName
                                          Definition

                                          Mother's maiden (unmarried) name, commonly collected to help verify patient identity.

                                          ShortMother's Maiden name
                                          Control0..1
                                          TypeExtension(Patient Mother's Maiden Name) (Extension Type: string)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          38. Patient.extension:mothersMaidenName.id
                                          Definition

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

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          40. Patient.extension:mothersMaidenName.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..0
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 42. Patient.extension:mothersMaidenName.url
                                            Definition

                                            Source of the definition for the extension code - a logical name or a URL.

                                            Shortidentifies the meaning of the extension
                                            Comments

                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
                                            44. Patient.extension:mothersMaidenName.value[x]
                                            Definition

                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                            ShortValue of extension
                                            Control1..1
                                            This element is affected by the following invariants: ext-1
                                            Typestring
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supportfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            46. Patient.extension:RESPPROVID
                                            Slice NameRESPPROVID
                                            Definition

                                            Responsible Provider ID.

                                            ShortExtension
                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(RESPPROVID) (Extension Type: Reference)
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            48. Patient.extension:RESPPROVID.id
                                            Definition

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

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

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

                                            ShortAdditional content defined by implementations
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Alternate Namesextensions, user content
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 52. Patient.extension:RESPPROVID.url
                                              Definition

                                              Source of the definition for the extension code - a logical name or a URL.

                                              Shortidentifies the meaning of the extension
                                              Comments

                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                              Control1..1
                                              Typeuri
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID
                                              54. Patient.extension:RESPPROVID.value[x]
                                              Definition

                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                              ShortValue of extension
                                              Control1..1
                                              TypeReference(Practitioner)
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              56. Patient.extension:REFDOCID
                                              Slice NameREFDOCID
                                              Definition

                                              Reference Doctor ID.

                                              ShortExtension
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(REFDOCID) (Extension Type: Reference)
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              58. Patient.extension:REFDOCID.id
                                              Definition

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

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

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

                                              ShortAdditional content defined by implementations
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 62. Patient.extension:REFDOCID.url
                                                Definition

                                                Source of the definition for the extension code - a logical name or a URL.

                                                Shortidentifies the meaning of the extension
                                                Comments

                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                Control1..1
                                                Typeuri
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supportfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID
                                                64. Patient.extension:REFDOCID.value[x]
                                                Definition

                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                ShortValue of extension
                                                Control1..1
                                                TypeReference(Practitioner)
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                66. Patient.extension:preferredContact
                                                Slice NamepreferredContact
                                                Definition

                                                Preferred Contact of the Patient.

                                                ShortExtension
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(prefferedContact) (Extension Type: string)
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                68. Patient.extension:preferredContact.id
                                                Definition

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

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

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

                                                ShortAdditional content defined by implementations
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 72. Patient.extension:preferredContact.url
                                                  Definition

                                                  Source of the definition for the extension code - a logical name or a URL.

                                                  Shortidentifies the meaning of the extension
                                                  Comments

                                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                  Control1..1
                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supportfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact
                                                  74. Patient.extension:preferredContact.value[x]
                                                  Definition

                                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                  ShortValue of extension
                                                  Control1..1
                                                  Typestring
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supportfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  76. Patient.extension:BIRTHTIME
                                                  Slice NameBIRTHTIME
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control0..1
                                                  TypeExtension(https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime)
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  78. Patient.extension:BIRTHTIME.id
                                                  Definition

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

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

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

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 82. Patient.extension:BIRTHTIME.url
                                                    Definition

                                                    Source of the definition for the extension code - a logical name or a URL.

                                                    Shortidentifies the meaning of the extension
                                                    Comments

                                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                    Control1..1
                                                    Typeuri
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supportfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime
                                                    84. Patient.extension:BIRTHTIME.value[x]
                                                    Definition

                                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                    ShortValue of extension
                                                    Control1..1
                                                    TypedateTime
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supportfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    86. Patient.extension:patientAsGuarantor
                                                    Slice NamepatientAsGuarantor
                                                    Definition

                                                    patient as guarantor.

                                                    ShortExtension
                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(patientAsGuarantor) (Extension Type: boolean)
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    88. Patient.extension:patientAsGuarantor.id
                                                    Definition

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

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

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

                                                    ShortAdditional content defined by implementations
                                                    Comments

                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 92. Patient.extension:patientAsGuarantor.url
                                                      Definition

                                                      Source of the definition for the extension code - a logical name or a URL.

                                                      Shortidentifies the meaning of the extension
                                                      Comments

                                                      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                      Control1..1
                                                      Typeuri
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supportfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor
                                                      94. Patient.extension:patientAsGuarantor.value[x]
                                                      Definition

                                                      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                      ShortValue of extension
                                                      Control1..1
                                                      Typeboolean
                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supportfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      96. Patient.extension:genderIdentity
                                                      Slice NamegenderIdentity
                                                      Definition

                                                      Gender Identity.

                                                      ShortExtension
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(genderIdentity) (Extension Type: CodeableConcept)
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      98. Patient.extension:genderIdentity.id
                                                      Definition

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

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

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

                                                      ShortAdditional content defined by implementations
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 102. Patient.extension:genderIdentity.url
                                                        Definition

                                                        Source of the definition for the extension code - a logical name or a URL.

                                                        Shortidentifies the meaning of the extension
                                                        Comments

                                                        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                        Control1..1
                                                        Typeuri
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Must Supportfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        Fixed Valuehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
                                                        104. Patient.extension:genderIdentity.value[x]
                                                        Definition

                                                        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                        ShortValue of extension
                                                        Control1..1
                                                        TypeCodeableConcept
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Is Modifierfalse
                                                        Must Supportfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        106. Patient.extension:sexualOrientation
                                                        Slice NamesexualOrientation
                                                        Definition

                                                        Sexual Orientation.

                                                        ShortExtension
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(sexualOrientation) (Extension Type: CodeableConcept)
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        108. Patient.extension:sexualOrientation.id
                                                        Definition

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

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

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

                                                        ShortAdditional content defined by implementations
                                                        Comments

                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Alternate Namesextensions, user content
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 112. Patient.extension:sexualOrientation.url
                                                          Definition

                                                          Source of the definition for the extension code - a logical name or a URL.

                                                          Shortidentifies the meaning of the extension
                                                          Comments

                                                          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                          Control1..1
                                                          Typeuri
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supportfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation
                                                          114. Patient.extension:sexualOrientation.value[x]
                                                          Definition

                                                          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                          ShortValue of extension
                                                          Control1..1
                                                          TypeCodeableConcept
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          116. Patient.extension:guarantorDetails
                                                          Slice NameguarantorDetails
                                                          Definition

                                                          Guarantor Id.

                                                          ShortExtension
                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          TypeExtension(guarantorDetails) (Extension Type: Reference)
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          118. Patient.extension:guarantorDetails.id
                                                          Definition

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

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

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

                                                          ShortAdditional content defined by implementations
                                                          Comments

                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                          Control0..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Alternate Namesextensions, user content
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 122. Patient.extension:guarantorDetails.url
                                                            Definition

                                                            Source of the definition for the extension code - a logical name or a URL.

                                                            Shortidentifies the meaning of the extension
                                                            Comments

                                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                            Control1..1
                                                            Typeuri
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supportfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails
                                                            124. Patient.extension:guarantorDetails.value[x]
                                                            Definition

                                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                            ShortValue of extension
                                                            Control1..1
                                                            TypeReference(RelatedPerson)
                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            126. Patient.extension:USCORERACE
                                                            Slice NameUSCORERACE
                                                            Definition

                                                            Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

                                                            • American Indian or Alaska Native
                                                            • Asian
                                                            • Black or African American
                                                            • Native Hawaiian or Other Pacific Islander
                                                            • White.
                                                            ShortUS Core Race Extension
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(US Core Race Extension) (Complex Extension)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            128. Patient.extension:USCOREETHNICITY
                                                            Slice NameUSCOREETHNICITY
                                                            Definition

                                                            Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

                                                            ShortUS Core ethnicity Extension
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(US Core Ethnicity Extension) (Complex Extension)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            130. Patient.extension:USCOREBIRTHSEX
                                                            Slice NameUSCOREBIRTHSEX
                                                            Definition

                                                            A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

                                                            ShortExtension
                                                            Comments

                                                            The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.

                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(US Core Birth Sex Extension) (Extension Type: code)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            132. Patient.extension:USCORESEX
                                                            Slice NameUSCORESEX
                                                            Definition

                                                            An Extension

                                                            ShortExtension
                                                            Control0..1
                                                            TypeExtension(http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            134. Patient.extension:PATIENTEDUCATUION
                                                            Slice NamePATIENTEDUCATUION
                                                            Definition

                                                            An Extension

                                                            ShortExtension
                                                            Control0..1
                                                            TypeExtension(https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            136. Patient.extension:OCCUPATION
                                                            Slice NameOCCUPATION
                                                            Definition

                                                            Occupation.

                                                            ShortExtension
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(occupation) (Extension Type: CodeableConcept)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            138. Patient.extension:OCCUPATION.id
                                                            Definition

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

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

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

                                                            ShortAdditional content defined by implementations
                                                            Comments

                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 142. Patient.extension:OCCUPATION.url
                                                              Definition

                                                              Source of the definition for the extension code - a logical name or a URL.

                                                              Shortidentifies the meaning of the extension
                                                              Comments

                                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                              Control1..1
                                                              Typeuri
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supportfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation
                                                              144. Patient.extension:OCCUPATION.value[x]
                                                              Definition

                                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                              ShortValue of extension
                                                              Control1..1
                                                              TypeCodeableConcept
                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              146. Patient.extension:OCCUPATIONINDUSTRY
                                                              Slice NameOCCUPATIONINDUSTRY
                                                              Definition

                                                              occupationIndustry.

                                                              ShortExtension
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              TypeExtension(occupationIndustry) (Extension Type: CodeableConcept)
                                                              Is Modifierfalse
                                                              Must Supporttrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              148. Patient.extension:OCCUPATIONINDUSTRY.id
                                                              Definition

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

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

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

                                                              ShortAdditional content defined by implementations
                                                              Comments

                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                              Control0..*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Alternate Namesextensions, user content
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 152. Patient.extension:OCCUPATIONINDUSTRY.url
                                                                Definition

                                                                Source of the definition for the extension code - a logical name or a URL.

                                                                Shortidentifies the meaning of the extension
                                                                Comments

                                                                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                Control1..1
                                                                Typeuri
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supportfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                Fixed Valuehttps://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry
                                                                154. Patient.extension:OCCUPATIONINDUSTRY.value[x]
                                                                Definition

                                                                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                ShortValue of extension
                                                                Control1..1
                                                                TypeCodeableConcept
                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                156. Patient.extension:TRIBALAFFILIATION
                                                                Slice NameTRIBALAFFILIATION
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control0..1
                                                                TypeExtension(http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation)
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                158. Patient.extension:PRONOUN
                                                                Slice NamePRONOUN
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control0..1
                                                                TypeExtension(http://terminology.hl7.org/ValueSet/pronouns)
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                160. Patient.extension:PRONOUN.id
                                                                Definition

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

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

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

                                                                ShortAdditional content defined by implementations
                                                                Comments

                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                Control0..*
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Alternate Namesextensions, user content
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 164. Patient.extension:PRONOUN.url
                                                                  Definition

                                                                  Source of the definition for the extension code - a logical name or a URL.

                                                                  Shortidentifies the meaning of the extension
                                                                  Comments

                                                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                                  Control1..1
                                                                  Typeuri
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supportfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  Fixed Valuehttp://terminology.hl7.org/ValueSet/pronouns
                                                                  166. Patient.extension:PRONOUN.value[x]
                                                                  Definition

                                                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                                  ShortValue of extension
                                                                  Control1..1
                                                                  TypeCodeableConcept
                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  168. Patient.modifierExtension
                                                                  Definition

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

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

                                                                  ShortExtensions that cannot be ignored
                                                                  Comments

                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                                                  Summaryfalse
                                                                  Requirements

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

                                                                  Alternate Namesextensions, user content
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  170. Patient.identifier
                                                                  Definition

                                                                  An identifier for this patient.

                                                                  ShortAn identifier for this patient
                                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                  Control1..*
                                                                  TypeIdentifier
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summarytrue
                                                                  Requirements

                                                                  Patients are almost always assigned specific numerical identifiers.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ type
                                                                  • 172. Patient.identifier
                                                                    Definition

                                                                    An identifier for this patient.

                                                                    ShortAn identifier for this patient
                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                    Control0..1
                                                                    TypeIdentifier
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    Summarytrue
                                                                    Requirements

                                                                    Patients are almost always assigned specific numerical identifiers.

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

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

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

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

                                                                    ShortAdditional content defined by implementations
                                                                    Comments

                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Alternate Namesextensions, user content
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 178. Patient.identifier.use
                                                                      Definition

                                                                      The purpose of this identifier.

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

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

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

                                                                      Identifies the purpose for this identifier, if known .

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

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

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

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

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

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Requirements

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

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

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

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

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

                                                                      ShortAdditional content defined by implementations
                                                                      Comments

                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 186. Patient.identifier.type.coding
                                                                        Definition

                                                                        A reference to a code defined by a terminology system.

                                                                        ShortCode defined by a terminology system
                                                                        Comments

                                                                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                        Control1..1
                                                                        TypeCoding
                                                                        Is Modifierfalse
                                                                        Must Supportfalse
                                                                        Summarytrue
                                                                        Requirements

                                                                        Allows for alternative encodings within a code system, and translations to other code systems.

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

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

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

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

                                                                        ShortAdditional content defined by implementations
                                                                        Comments

                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                        Control0..*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Alternate Namesextensions, user content
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 192. Patient.identifier.type.coding.system
                                                                          Definition

                                                                          The identification of the code system that defines the meaning of the symbol in the code.

                                                                          ShortIdentity of the terminology system
                                                                          Comments

                                                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                                                                          Need to be unambiguous about the source of the definition of the symbol.

                                                                          Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          194. Patient.identifier.type.coding.version
                                                                          Definition

                                                                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                          ShortVersion of the system - if relevant
                                                                          Comments

                                                                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                          NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          196. Patient.identifier.type.coding.code
                                                                          Definition

                                                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                          ShortSymbol in syntax defined by the system
                                                                          Control1..1
                                                                          Typecode
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supportfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          Need to refer to a particular code in the system.

                                                                          Fixed ValuePI
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          198. Patient.identifier.type.coding.display
                                                                          Definition

                                                                          A representation of the meaning of the code in the system, following the rules of the system.

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

                                                                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

                                                                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                          ShortIf this coding was chosen directly by the user
                                                                          Comments

                                                                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                          ShortPlain text representation of the concept
                                                                          Comments

                                                                          Very often the text is the same as a displayName of one of the codings.

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

                                                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

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

                                                                          ShortThe namespace for the identifier value
                                                                          Comments

                                                                          Identifier.system is always case sensitive.

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

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

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

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

                                                                          ShortThe value that is unique
                                                                          Comments

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

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

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

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

                                                                          Organization that issued/manages the identifier.

                                                                          ShortOrganization that issued id (may be just text)
                                                                          Comments

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

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

                                                                          An identifier for this patient.

                                                                          ShortAn identifier for this patient
                                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                          Control0..1
                                                                          TypeIdentifier
                                                                          Is Modifierfalse
                                                                          Must Supportfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          Patients are almost always assigned specific numerical identifiers.

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

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

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

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

                                                                          ShortAdditional content defined by implementations
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 218. Patient.identifier.use
                                                                            Definition

                                                                            The purpose of this identifier.

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

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

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

                                                                            Identifies the purpose for this identifier, if known .

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

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

                                                                            Fixed Valuesecondary
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            220. Patient.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)

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

                                                                            TypeCodeableConcept
                                                                            Is Modifierfalse
                                                                            Must Supporttrue
                                                                            Summarytrue
                                                                            Requirements

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

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

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

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

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

                                                                            ShortAdditional content defined by implementations
                                                                            Comments

                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                            Control0..*
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Alternate Namesextensions, user content
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 226. Patient.identifier.type.coding
                                                                              Definition

                                                                              A reference to a code defined by a terminology system.

                                                                              ShortCode defined by a terminology system
                                                                              Comments

                                                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                              Control1..1
                                                                              TypeCoding
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summarytrue
                                                                              Requirements

                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

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

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

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

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

                                                                              ShortAdditional content defined by implementations
                                                                              Comments

                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 232. Patient.identifier.type.coding.system
                                                                                Definition

                                                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                                                ShortIdentity of the terminology system
                                                                                Comments

                                                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                                                                                Need to be unambiguous about the source of the definition of the symbol.

                                                                                Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                234. Patient.identifier.type.coding.version
                                                                                Definition

                                                                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                ShortVersion of the system - if relevant
                                                                                Comments

                                                                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                236. Patient.identifier.type.coding.code
                                                                                Definition

                                                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                ShortSymbol in syntax defined by the system
                                                                                Control1..1
                                                                                Typecode
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supportfalse
                                                                                Summarytrue
                                                                                Requirements

                                                                                Need to refer to a particular code in the system.

                                                                                Fixed ValueSB
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                238. Patient.identifier.type.coding.display
                                                                                Definition

                                                                                A representation of the meaning of the code in the system, following the rules of the system.

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

                                                                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

                                                                                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                ShortIf this coding was chosen directly by the user
                                                                                Comments

                                                                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                                                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                ShortPlain text representation of the concept
                                                                                Comments

                                                                                Very often the text is the same as a displayName of one of the codings.

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

                                                                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

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

                                                                                ShortThe namespace for the identifier value
                                                                                Comments

                                                                                Identifier.system is always case sensitive.

                                                                                Control1..1
                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supporttrue
                                                                                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.

                                                                                Fixed Valuehttp://hl7.org/fhir/sid/us-ssn
                                                                                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                246. Patient.identifier.value
                                                                                Definition

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

                                                                                ShortThe value that is unique
                                                                                Comments

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

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

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

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

                                                                                Organization that issued/manages the identifier.

                                                                                ShortOrganization that issued id (may be just text)
                                                                                Comments

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

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

                                                                                An identifier for this patient.

                                                                                ShortAn identifier for this patient
                                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                Control0..1
                                                                                TypeIdentifier
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summarytrue
                                                                                Requirements

                                                                                Patients are almost always assigned specific numerical identifiers.

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

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

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

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

                                                                                ShortAdditional content defined by implementations
                                                                                Comments

                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                Control0..*
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Alternate Namesextensions, user content
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 258. Patient.identifier.use
                                                                                  Definition

                                                                                  The purpose of this identifier.

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

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

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

                                                                                  Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                                  TypeCodeableConcept
                                                                                  Is Modifierfalse
                                                                                  Must Supporttrue
                                                                                  Summarytrue
                                                                                  Requirements

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

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

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

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

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

                                                                                  ShortAdditional content defined by implementations
                                                                                  Comments

                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                  Control0..*
                                                                                  TypeExtension
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Alternate Namesextensions, user content
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 266. Patient.identifier.type.coding
                                                                                    Definition

                                                                                    A reference to a code defined by a terminology system.

                                                                                    ShortCode defined by a terminology system
                                                                                    Comments

                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                    Control1..1
                                                                                    TypeCoding
                                                                                    Is Modifierfalse
                                                                                    Must Supportfalse
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

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

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

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

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

                                                                                    ShortAdditional content defined by implementations
                                                                                    Comments

                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                    Control0..*
                                                                                    TypeExtension
                                                                                    Is Modifierfalse
                                                                                    Summaryfalse
                                                                                    Alternate Namesextensions, user content
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                    SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 272. Patient.identifier.type.coding.system
                                                                                      Definition

                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                      ShortIdentity of the terminology system
                                                                                      Comments

                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                      Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      274. Patient.identifier.type.coding.version
                                                                                      Definition

                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                      ShortVersion of the system - if relevant
                                                                                      Comments

                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      276. Patient.identifier.type.coding.code
                                                                                      Definition

                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                      ShortSymbol in syntax defined by the system
                                                                                      Control1..1
                                                                                      Typecode
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Must Supportfalse
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Need to refer to a particular code in the system.

                                                                                      Fixed ValueMR
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      278. Patient.identifier.type.coding.display
                                                                                      Definition

                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

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

                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                      ShortIf this coding was chosen directly by the user
                                                                                      Comments

                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                      ShortPlain text representation of the concept
                                                                                      Comments

                                                                                      Very often the text is the same as a displayName of one of the codings.

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

                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

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

                                                                                      ShortThe namespace for the identifier value
                                                                                      Comments

                                                                                      Identifier.system is always case sensitive.

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

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

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

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

                                                                                      ShortThe value that is unique
                                                                                      Comments

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

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

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

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

                                                                                      Organization that issued/manages the identifier.

                                                                                      ShortOrganization that issued id (may be just text)
                                                                                      Comments

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

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

                                                                                      An identifier for this patient.

                                                                                      ShortAn identifier for this patient
                                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                      Control0..*
                                                                                      TypeIdentifier
                                                                                      Is Modifierfalse
                                                                                      Must Supportfalse
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Patients are almost always assigned specific numerical identifiers.

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

                                                                                      Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                                                                      It is often used to filter patient lists to exclude inactive patients

                                                                                      Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                                                                      ShortWhether this patient's record is in active use
                                                                                      Comments

                                                                                      If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

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

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

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

                                                                                      A name associated with the individual.

                                                                                      ShortA name associated with the patient
                                                                                      Comments

                                                                                      A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                                                      Control1..*
                                                                                      TypeHumanName
                                                                                      Is Modifierfalse
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Requirements

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

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ use
                                                                                      • 298. Patient.name:Name
                                                                                        Slice NameName
                                                                                        Definition

                                                                                        A name associated with the individual.

                                                                                        ShortA name associated with the patient
                                                                                        Comments

                                                                                        A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                                                        Control1..1
                                                                                        TypeHumanName
                                                                                        Is Modifierfalse
                                                                                        Must Supporttrue
                                                                                        Summarytrue
                                                                                        Requirements

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

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

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

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        302. Patient.name:Name.extension
                                                                                        Definition

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

                                                                                        ShortAdditional content defined by implementations
                                                                                        Comments

                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                        Control0..*
                                                                                        TypeExtension
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Alternate Namesextensions, user content
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 304. Patient.name:Name.use
                                                                                          Definition

                                                                                          Identifies the purpose for this name.

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

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

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

                                                                                          The use of a human name.

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

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

                                                                                          Fixed Valueofficial
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          306. Patient.name:Name.text
                                                                                          Definition

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

                                                                                          ShortText representation of the full name
                                                                                          Comments

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

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

                                                                                          A renderable, unencoded form.

                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          308. Patient.name:Name.family
                                                                                          Definition

                                                                                          The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                                          ShortFamily name (often called 'Surname')
                                                                                          Comments

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

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

                                                                                          Given name.

                                                                                          ShortGiven names (not always 'first'). Includes middle names
                                                                                          Comments

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

                                                                                          Control0..2
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Must Supportfalse
                                                                                          Summarytrue
                                                                                          Alternate Namesfirst name, middle name
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          SlicingThis element introduces a set of slices on Patient.name.given. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                          • value @ given
                                                                                          • 312. Patient.name:Name.given:First Name
                                                                                            Slice NameFirst Name
                                                                                            Definition

                                                                                            Given name.

                                                                                            ShortGiven names (not always 'first'). Includes middle names
                                                                                            Comments

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

                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Must Supportfalse
                                                                                            Summarytrue
                                                                                            Alternate Namesfirst name, middle name
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            314. Patient.name:Name.given:Middle Name
                                                                                            Slice NameMiddle Name
                                                                                            Definition

                                                                                            Given name.

                                                                                            ShortGiven names (not always 'first'). Includes middle names
                                                                                            Comments

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

                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Must Supportfalse
                                                                                            Summarytrue
                                                                                            Alternate Namesfirst name, middle name
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            316. Patient.name: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..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Must Supportfalse
                                                                                            Summarytrue
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            318. Patient.name: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..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Must Supportfalse
                                                                                            Summarytrue
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            320. Patient.name:Name.period
                                                                                            Definition

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

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

                                                                                            Allows names to be placed in historical context.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            322. Patient.name:PreviousName
                                                                                            Slice NamePreviousName
                                                                                            Definition

                                                                                            A name associated with the individual.

                                                                                            ShortA name associated with the patient
                                                                                            Comments

                                                                                            A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                                                            Control0..1
                                                                                            TypeHumanName
                                                                                            Is Modifierfalse
                                                                                            Must Supporttrue
                                                                                            Summarytrue
                                                                                            Requirements

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

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

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

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            326. Patient.name:PreviousName.extension
                                                                                            Definition

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

                                                                                            ShortAdditional content defined by implementations
                                                                                            Comments

                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            Alternate Namesextensions, user content
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                            SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ url
                                                                                            • 328. Patient.name:PreviousName.use
                                                                                              Definition

                                                                                              Identifies the purpose for this name.

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

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

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

                                                                                              The use of a human name.

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

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

                                                                                              Fixed Valueold
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              330. Patient.name:PreviousName.text
                                                                                              Definition

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

                                                                                              ShortText representation of the full name
                                                                                              Comments

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

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

                                                                                              A renderable, unencoded form.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              332. Patient.name:PreviousName.family
                                                                                              Definition

                                                                                              The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                                              ShortFamily name (often called 'Surname')
                                                                                              Comments

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

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

                                                                                              Given name.

                                                                                              ShortGiven names (not always 'first'). Includes middle names
                                                                                              Comments

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

                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Alternate Namesfirst name, middle name
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              SlicingThis element introduces a set of slices on Patient.name.given. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                              • value @ given
                                                                                              • 336. Patient.name:PreviousName.given:Previous First Name
                                                                                                Slice NamePrevious First Name
                                                                                                Definition

                                                                                                Given name.

                                                                                                ShortGiven names (not always 'first'). Includes middle names
                                                                                                Comments

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

                                                                                                Control0..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                Must Supportfalse
                                                                                                Summarytrue
                                                                                                Alternate Namesfirst name, middle name
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                338. Patient.name:PreviousName.given:Previous Middle Name
                                                                                                Slice NamePrevious Middle Name
                                                                                                Definition

                                                                                                Given name.

                                                                                                ShortGiven names (not always 'first'). Includes middle names
                                                                                                Comments

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

                                                                                                Control0..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                Must Supportfalse
                                                                                                Summarytrue
                                                                                                Alternate Namesfirst name, middle name
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                340. Patient.name:PreviousName.prefix
                                                                                                Definition

                                                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                                                ShortParts that come before the name
                                                                                                Control0..*
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                Summarytrue
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                342. Patient.name:PreviousName.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..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                Must Supportfalse
                                                                                                Summarytrue
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                344. Patient.name:PreviousName.period
                                                                                                Definition

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

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

                                                                                                Allows names to be placed in historical context.

                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                346. Patient.name:Nickname
                                                                                                Slice NameNickname
                                                                                                Definition

                                                                                                A name associated with the individual.

                                                                                                ShortA name associated with the patient
                                                                                                Comments

                                                                                                A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

                                                                                                Control0..1
                                                                                                TypeHumanName
                                                                                                Is Modifierfalse
                                                                                                Must Supportfalse
                                                                                                Summarytrue
                                                                                                Requirements

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

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

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

                                                                                                ShortUnique id for inter-element referencing
                                                                                                Control0..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                350. Patient.name:Nickname.extension
                                                                                                Definition

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

                                                                                                ShortAdditional content defined by implementations
                                                                                                Comments

                                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                Control0..*
                                                                                                TypeExtension
                                                                                                Is Modifierfalse
                                                                                                Summaryfalse
                                                                                                Alternate Namesextensions, user content
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                • value @ url
                                                                                                • 352. Patient.name:Nickname.use
                                                                                                  Definition

                                                                                                  Identifies the purpose for this name.

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

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

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

                                                                                                  The use of a human name.

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

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

                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  354. Patient.name:Nickname.text
                                                                                                  Definition

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

                                                                                                  ShortText representation of the full name
                                                                                                  Comments

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

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

                                                                                                  A renderable, unencoded form.

                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  356. Patient.name:Nickname.family
                                                                                                  Definition

                                                                                                  The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                                                  ShortFamily name (often called 'Surname')
                                                                                                  Comments

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

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

                                                                                                  Given name.

                                                                                                  ShortGiven names (not always 'first'). Includes middle names
                                                                                                  Comments

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

                                                                                                  Control0..1
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supportfalse
                                                                                                  Summarytrue
                                                                                                  Alternate Namesfirst name, middle name
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  360. Patient.name:Nickname.prefix
                                                                                                  Definition

                                                                                                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                                                  ShortParts that come before the name
                                                                                                  Control0..*
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Summarytrue
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  362. Patient.name:Nickname.suffix
                                                                                                  Definition

                                                                                                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                                                  ShortParts that come after the name
                                                                                                  Control0..*
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Summarytrue
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  364. Patient.name:Nickname.period
                                                                                                  Definition

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

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

                                                                                                  Allows names to be placed in historical context.

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

                                                                                                  A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                                                  ShortA contact detail for the individual
                                                                                                  Comments

                                                                                                  A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                  Control0..6
                                                                                                  TypeContactPoint
                                                                                                  Is Modifierfalse
                                                                                                  Must Supportfalse
                                                                                                  Summarytrue
                                                                                                  Requirements

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

                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                  • value @ use
                                                                                                  • 368. Patient.telecom:Work
                                                                                                    Slice NameWork
                                                                                                    Definition

                                                                                                    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                                                    ShortA contact detail for the individual
                                                                                                    Comments

                                                                                                    A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                    Control0..1
                                                                                                    TypeContactPoint
                                                                                                    Is Modifierfalse
                                                                                                    Must Supportfalse
                                                                                                    Summarytrue
                                                                                                    Requirements

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

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

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

                                                                                                    ShortUnique id for inter-element referencing
                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                    Summaryfalse
                                                                                                    372. Patient.telecom:Work.extension
                                                                                                    Definition

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

                                                                                                    ShortAdditional content defined by implementations
                                                                                                    Comments

                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                    Control0..*
                                                                                                    TypeExtension
                                                                                                    Is Modifierfalse
                                                                                                    Summaryfalse
                                                                                                    Alternate Namesextensions, user content
                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                    SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                    • value @ url
                                                                                                    • 374. Patient.telecom:Work.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
                                                                                                      Control1..1
                                                                                                      This element is affected by the following invariants: cpt-2
                                                                                                      BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                      Telecommunications form for contact point.

                                                                                                      Typecode
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Must Supporttrue
                                                                                                      Summarytrue
                                                                                                      Fixed Valuephone
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      376. Patient.telecom:Work.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.

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

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

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

                                                                                                      Identifies the purpose for the contact point.

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

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

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

                                                                                                      Use of contact point.

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

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

                                                                                                      Fixed Valuework
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      380. Patient.telecom:Work.rank
                                                                                                      Definition

                                                                                                      Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                      ShortSpecify preferred order of use (1 = highest)
                                                                                                      Comments

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

                                                                                                      Control0..1
                                                                                                      TypepositiveInt
                                                                                                      Is Modifierfalse
                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                      Summarytrue
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      382. Patient.telecom:Work.period
                                                                                                      Definition

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

                                                                                                      ShortTime period when the contact point was/is in use
                                                                                                      Control0..1
                                                                                                      TypePeriod
                                                                                                      Is Modifierfalse
                                                                                                      Summarytrue
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      384. Patient.telecom:Home
                                                                                                      Slice NameHome
                                                                                                      Definition

                                                                                                      A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                                                      ShortA contact detail for the individual
                                                                                                      Comments

                                                                                                      A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                      Control0..1
                                                                                                      TypeContactPoint
                                                                                                      Is Modifierfalse
                                                                                                      Must Supportfalse
                                                                                                      Summarytrue
                                                                                                      Requirements

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

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

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      388. Patient.telecom:Home.extension
                                                                                                      Definition

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

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                      • value @ url
                                                                                                      • 390. Patient.telecom:Home.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
                                                                                                        Control1..1
                                                                                                        This element is affected by the following invariants: cpt-2
                                                                                                        BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                        Telecommunications form for contact point.

                                                                                                        Typecode
                                                                                                        Is Modifierfalse
                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                        Must Supporttrue
                                                                                                        Summarytrue
                                                                                                        Fixed Valuephone
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        392. Patient.telecom:Home.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.

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

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

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

                                                                                                        Identifies the purpose for the contact point.

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

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

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

                                                                                                        Use of contact point.

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

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

                                                                                                        Fixed Valuehome
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        396. Patient.telecom:Home.rank
                                                                                                        Definition

                                                                                                        Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                        ShortSpecify preferred order of use (1 = highest)
                                                                                                        Comments

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

                                                                                                        Control0..1
                                                                                                        TypepositiveInt
                                                                                                        Is Modifierfalse
                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                        Summarytrue
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        398. Patient.telecom:Home.period
                                                                                                        Definition

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

                                                                                                        ShortTime period when the contact point was/is in use
                                                                                                        Control0..1
                                                                                                        TypePeriod
                                                                                                        Is Modifierfalse
                                                                                                        Summarytrue
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        400. Patient.telecom:Mobile
                                                                                                        Slice NameMobile
                                                                                                        Definition

                                                                                                        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                                                        ShortA contact detail for the individual
                                                                                                        Comments

                                                                                                        A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                        Control0..1
                                                                                                        TypeContactPoint
                                                                                                        Is Modifierfalse
                                                                                                        Must Supportfalse
                                                                                                        Summarytrue
                                                                                                        Requirements

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

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

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

                                                                                                        ShortUnique id for inter-element referencing
                                                                                                        Control0..1
                                                                                                        Typestring
                                                                                                        Is Modifierfalse
                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                        Summaryfalse
                                                                                                        404. Patient.telecom:Mobile.extension
                                                                                                        Definition

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

                                                                                                        ShortAdditional content defined by implementations
                                                                                                        Comments

                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                        Control0..*
                                                                                                        TypeExtension
                                                                                                        Is Modifierfalse
                                                                                                        Summaryfalse
                                                                                                        Alternate Namesextensions, user content
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                        SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                        • value @ url
                                                                                                        • 406. Patient.telecom:Mobile.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
                                                                                                          Control1..1
                                                                                                          This element is affected by the following invariants: cpt-2
                                                                                                          BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                          Telecommunications form for contact point.

                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Summarytrue
                                                                                                          Fixed Valuephone
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          408. Patient.telecom:Mobile.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.

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

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

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

                                                                                                          Identifies the purpose for the contact point.

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

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

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

                                                                                                          Use of contact point.

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

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

                                                                                                          Fixed Valuemobile
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          412. Patient.telecom:Mobile.rank
                                                                                                          Definition

                                                                                                          Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                          ShortSpecify preferred order of use (1 = highest)
                                                                                                          Comments

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

                                                                                                          Control0..1
                                                                                                          TypepositiveInt
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Summarytrue
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          414. Patient.telecom:Mobile.period
                                                                                                          Definition

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

                                                                                                          ShortTime period when the contact point was/is in use
                                                                                                          Control0..1
                                                                                                          TypePeriod
                                                                                                          Is Modifierfalse
                                                                                                          Summarytrue
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          416. Patient.telecom:Fax
                                                                                                          Slice NameFax
                                                                                                          Definition

                                                                                                          A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                                                          ShortA contact detail for the individual
                                                                                                          Comments

                                                                                                          A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                          Control0..1
                                                                                                          TypeContactPoint
                                                                                                          Is Modifierfalse
                                                                                                          Must Supportfalse
                                                                                                          Summarytrue
                                                                                                          Requirements

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

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

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

                                                                                                          ShortUnique id for inter-element referencing
                                                                                                          Control0..1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          420. Patient.telecom:Fax.extension
                                                                                                          Definition

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

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                          • value @ url
                                                                                                          • 422. Patient.telecom:Fax.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
                                                                                                            Control1..1
                                                                                                            This element is affected by the following invariants: cpt-2
                                                                                                            BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                            Telecommunications form for contact point.

                                                                                                            Typecode
                                                                                                            Is Modifierfalse
                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                            Must Supporttrue
                                                                                                            Summarytrue
                                                                                                            Fixed Valuefax
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            424. Patient.telecom:Fax.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.

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

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

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

                                                                                                            Identifies the purpose for the contact point.

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

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

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

                                                                                                            Use of contact point.

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

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

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            428. Patient.telecom:Fax.rank
                                                                                                            Definition

                                                                                                            Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                            ShortSpecify preferred order of use (1 = highest)
                                                                                                            Comments

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

                                                                                                            Control0..1
                                                                                                            TypepositiveInt
                                                                                                            Is Modifierfalse
                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                            Summarytrue
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            430. Patient.telecom:Fax.period
                                                                                                            Definition

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

                                                                                                            ShortTime period when the contact point was/is in use
                                                                                                            Control0..1
                                                                                                            TypePeriod
                                                                                                            Is Modifierfalse
                                                                                                            Summarytrue
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            432. Patient.telecom:Pager
                                                                                                            Slice NamePager
                                                                                                            Definition

                                                                                                            A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                                                            ShortA contact detail for the individual
                                                                                                            Comments

                                                                                                            A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                            Control0..1
                                                                                                            TypeContactPoint
                                                                                                            Is Modifierfalse
                                                                                                            Must Supportfalse
                                                                                                            Summarytrue
                                                                                                            Requirements

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

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

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

                                                                                                            ShortUnique id for inter-element referencing
                                                                                                            Control0..1
                                                                                                            Typestring
                                                                                                            Is Modifierfalse
                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                            Summaryfalse
                                                                                                            436. Patient.telecom:Pager.extension
                                                                                                            Definition

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

                                                                                                            ShortAdditional content defined by implementations
                                                                                                            Comments

                                                                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                            Control0..*
                                                                                                            TypeExtension
                                                                                                            Is Modifierfalse
                                                                                                            Summaryfalse
                                                                                                            Alternate Namesextensions, user content
                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                            SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                            • value @ url
                                                                                                            • 438. Patient.telecom:Pager.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
                                                                                                              Control1..1
                                                                                                              This element is affected by the following invariants: cpt-2
                                                                                                              BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                              (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                              Telecommunications form for contact point.

                                                                                                              Typecode
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Fixed Valuepager
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              440. Patient.telecom:Pager.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.

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

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

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

                                                                                                              Identifies the purpose for the contact point.

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

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

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

                                                                                                              Use of contact point.

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

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

                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              444. Patient.telecom:Pager.rank
                                                                                                              Definition

                                                                                                              Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                              ShortSpecify preferred order of use (1 = highest)
                                                                                                              Comments

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

                                                                                                              Control0..1
                                                                                                              TypepositiveInt
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Summarytrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              446. Patient.telecom:Pager.period
                                                                                                              Definition

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

                                                                                                              ShortTime period when the contact point was/is in use
                                                                                                              Control0..1
                                                                                                              TypePeriod
                                                                                                              Is Modifierfalse
                                                                                                              Summarytrue
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              448. Patient.telecom:Email
                                                                                                              Slice NameEmail
                                                                                                              Definition

                                                                                                              A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                                                              ShortA contact detail for the individual
                                                                                                              Comments

                                                                                                              A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                                                              Control0..1
                                                                                                              TypeContactPoint
                                                                                                              Is Modifierfalse
                                                                                                              Must Supportfalse
                                                                                                              Summarytrue
                                                                                                              Requirements

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

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

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

                                                                                                              ShortUnique id for inter-element referencing
                                                                                                              Control0..1
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              452. Patient.telecom:Email.extension
                                                                                                              Definition

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

                                                                                                              ShortAdditional content defined by implementations
                                                                                                              Comments

                                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                              Control0..*
                                                                                                              TypeExtension
                                                                                                              Is Modifierfalse
                                                                                                              Summaryfalse
                                                                                                              Alternate Namesextensions, user content
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                              SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                              • value @ url
                                                                                                              • 454. Patient.telecom:Email.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
                                                                                                                Control1..1
                                                                                                                This element is affected by the following invariants: cpt-2
                                                                                                                BindingThe codes SHALL be taken from ContactPointSystem
                                                                                                                (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

                                                                                                                Telecommunications form for contact point.

                                                                                                                Typecode
                                                                                                                Is Modifierfalse
                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                Must Supporttrue
                                                                                                                Summarytrue
                                                                                                                Fixed Valueemail
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                456. Patient.telecom:Email.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.

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

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

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

                                                                                                                Identifies the purpose for the contact point.

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

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

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

                                                                                                                Use of contact point.

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

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

                                                                                                                Fixed Valuehome
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                460. Patient.telecom:Email.rank
                                                                                                                Definition

                                                                                                                Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                                                ShortSpecify preferred order of use (1 = highest)
                                                                                                                Comments

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

                                                                                                                Control0..1
                                                                                                                TypepositiveInt
                                                                                                                Is Modifierfalse
                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                Summarytrue
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                462. Patient.telecom:Email.period
                                                                                                                Definition

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

                                                                                                                ShortTime period when the contact point was/is in use
                                                                                                                Control0..1
                                                                                                                TypePeriod
                                                                                                                Is Modifierfalse
                                                                                                                Summarytrue
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                464. Patient.gender
                                                                                                                Definition

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

                                                                                                                Shortmale | female | other | unknown
                                                                                                                Comments

                                                                                                                The gender might 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 male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

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

                                                                                                                The gender of a person used for administrative purposes.

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

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

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

                                                                                                                The date of birth for the individual.

                                                                                                                ShortThe date of birth for the individual
                                                                                                                Comments

                                                                                                                At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

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

                                                                                                                Age of the individual drives many clinical processes.

                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                LOINC Code21112-8
                                                                                                                468. Patient.deceased[x]
                                                                                                                Definition

                                                                                                                Indicates if the individual is deceased or not.

                                                                                                                ShortIndicates if the individual is deceased or not
                                                                                                                Comments

                                                                                                                If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                                                                Control0..1
                                                                                                                TypeChoice of: boolean, dateTime
                                                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                Must Supporttrue
                                                                                                                Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                Summarytrue
                                                                                                                Requirements

                                                                                                                The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

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

                                                                                                                An address for the individual.

                                                                                                                ShortAn address for the individual
                                                                                                                Comments

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

                                                                                                                Control1..*
                                                                                                                TypeAddress
                                                                                                                Is Modifierfalse
                                                                                                                Must Supporttrue
                                                                                                                Summarytrue
                                                                                                                Requirements

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

                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                • value @ use
                                                                                                                • 472. Patient.address:Current Address
                                                                                                                  Slice NameCurrent Address
                                                                                                                  Definition

                                                                                                                  An address for the individual.

                                                                                                                  ShortAn address for the individual
                                                                                                                  Comments

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

                                                                                                                  Control0..1
                                                                                                                  TypeAddress
                                                                                                                  Is Modifierfalse
                                                                                                                  Must Supporttrue
                                                                                                                  Summarytrue
                                                                                                                  Requirements

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

                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  474. Patient.address:Current Address.id
                                                                                                                  Definition

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

                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                  Control0..1
                                                                                                                  Typestring
                                                                                                                  Is Modifierfalse
                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                  Summaryfalse
                                                                                                                  476. Patient.address:Current Address.extension
                                                                                                                  Definition

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

                                                                                                                  ShortAdditional content defined by implementations
                                                                                                                  Comments

                                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                  Control0..*
                                                                                                                  TypeExtension
                                                                                                                  Is Modifierfalse
                                                                                                                  Summaryfalse
                                                                                                                  Alternate Namesextensions, user content
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                  SlicingThis element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                  • value @ url
                                                                                                                  • 478. Patient.address:Current Address.use
                                                                                                                    Definition

                                                                                                                    The purpose of this address.

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

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

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

                                                                                                                    The use of an address.

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

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

                                                                                                                    Fixed Valuehome
                                                                                                                    Example<br/><b>General</b>:home
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    480. Patient.address:Current Address.type
                                                                                                                    Definition

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

                                                                                                                    Shortpostal | physical | both
                                                                                                                    Comments

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

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

                                                                                                                    The type of an address (physical / postal).

                                                                                                                    Typecode
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Summarytrue
                                                                                                                    Example<br/><b>General</b>:both
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    482. Patient.address:Current Address.text
                                                                                                                    Definition

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

                                                                                                                    ShortText representation of the address
                                                                                                                    Comments

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

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

                                                                                                                    A renderable, unencoded form.

                                                                                                                    Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    484. Patient.address:Current 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..2
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                    Must Supportfalse
                                                                                                                    Summarytrue
                                                                                                                    Example<br/><b>General</b>:137 Nowhere Street
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    SlicingThis element introduces a set of slices on Patient.address.line. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                    • value @ line
                                                                                                                    • 486. Patient.address:Current 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..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supportfalse
                                                                                                                      Summarytrue
                                                                                                                      Example<br/><b>General</b>:137 Nowhere Street
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      488. Patient.address:Current 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..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supportfalse
                                                                                                                      Summarytrue
                                                                                                                      Example<br/><b>General</b>:137 Nowhere Street
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      490. Patient.address:Current Address.city
                                                                                                                      Definition

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

                                                                                                                      ShortName of city, town etc.
                                                                                                                      Control0..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supportfalse
                                                                                                                      Summarytrue
                                                                                                                      Alternate NamesMunicpality
                                                                                                                      Example<br/><b>General</b>:Erewhon
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      492. Patient.address:Current Address.district
                                                                                                                      Definition

                                                                                                                      The name of the administrative area (county).

                                                                                                                      ShortDistrict name (aka county)
                                                                                                                      Comments

                                                                                                                      District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                                                                                      Control0..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Summarytrue
                                                                                                                      Alternate NamesCounty
                                                                                                                      Example<br/><b>General</b>:Madison
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      494. Patient.address:Current Address.state
                                                                                                                      Definition

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

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

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

                                                                                                                      ShortPostal code for area
                                                                                                                      Control0..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supportfalse
                                                                                                                      Summarytrue
                                                                                                                      Alternate NamesZip
                                                                                                                      Example<br/><b>General</b>:9132
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      498. Patient.address:Current Address.country
                                                                                                                      Definition

                                                                                                                      Country - a nation as commonly understood or generally accepted.

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

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

                                                                                                                      Control0..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supportfalse
                                                                                                                      Summarytrue
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      500. Patient.address:Current Address.period
                                                                                                                      Definition

                                                                                                                      Time period when address was/is in use.

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

                                                                                                                      Allows addresses to be placed in historical context.

                                                                                                                      Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      502. Patient.address:Previous Address
                                                                                                                      Slice NamePrevious Address
                                                                                                                      Definition

                                                                                                                      An address for the individual.

                                                                                                                      ShortAn address for the individual
                                                                                                                      Comments

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

                                                                                                                      Control0..*
                                                                                                                      TypeAddress
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supporttrue
                                                                                                                      Summarytrue
                                                                                                                      Requirements

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

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

                                                                                                                      This field contains a patient's most recent marital (civil) status.

                                                                                                                      ShortMarital (civil) status of a patient
                                                                                                                      Control0..1
                                                                                                                      BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
                                                                                                                      (extensible to http://hl7.org/fhir/ValueSet/marital-status)

                                                                                                                      The domestic partnership status of a person.

                                                                                                                      TypeCodeableConcept
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supporttrue
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

                                                                                                                      Most, if not all systems capture it.

                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      506. Patient.multipleBirth[x]
                                                                                                                      Definition

                                                                                                                      Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                                                      ShortWhether patient is part of a multiple birth
                                                                                                                      Comments

                                                                                                                      Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                                                      Control0..1
                                                                                                                      TypeChoice of: boolean, integer
                                                                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

                                                                                                                      For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

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

                                                                                                                      Image of the patient.

                                                                                                                      ShortImage of the patient
                                                                                                                      Comments

                                                                                                                      Guidelines:

                                                                                                                      • Use id photos, not clinical photos.
                                                                                                                      • Limit dimensions to thumbnail.
                                                                                                                      • Keep byte count low to ease resource updates.
                                                                                                                      Control0..*
                                                                                                                      TypeAttachment
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

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

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

                                                                                                                      A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                                                      ShortA contact party (e.g. guardian, partner, friend) for the patient
                                                                                                                      Comments

                                                                                                                      Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                                                      Control0..*
                                                                                                                      TypeBackboneElement
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

                                                                                                                      Need to track people you can contact about the patient.

                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                                                      512. Patient.contact.id
                                                                                                                      Definition

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

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

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

                                                                                                                      ShortAdditional content defined by implementations
                                                                                                                      Comments

                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                      Control0..*
                                                                                                                      TypeExtension
                                                                                                                      Is Modifierfalse
                                                                                                                      Summaryfalse
                                                                                                                      Alternate Namesextensions, user content
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                      516. Patient.contact.modifierExtension
                                                                                                                      Definition

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

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

                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                      Comments

                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                      Control0..*
                                                                                                                      TypeExtension
                                                                                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                      Summarytrue
                                                                                                                      Requirements

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

                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                      518. Patient.contact.relationship
                                                                                                                      Definition

                                                                                                                      The nature of the relationship between the patient and the contact person.

                                                                                                                      ShortThe kind of relationship
                                                                                                                      Control0..*
                                                                                                                      BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                                                      (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                                                                      The nature of the relationship between a patient and a contact person for that patient.

                                                                                                                      TypeCodeableConcept
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

                                                                                                                      Used to determine which contact person is the most relevant to approach, depending on circumstances.

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

                                                                                                                      A name associated with the contact person.

                                                                                                                      ShortA name associated with the contact person
                                                                                                                      Control0..1
                                                                                                                      TypeHumanName
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

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

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

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

                                                                                                                      ShortA contact detail for the person
                                                                                                                      Comments

                                                                                                                      Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                                                                      Control0..*
                                                                                                                      TypeContactPoint
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

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

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

                                                                                                                      Address for the contact person.

                                                                                                                      ShortAddress for the contact person
                                                                                                                      Control0..1
                                                                                                                      TypeAddress
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

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

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

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

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

                                                                                                                      The gender of a person used for administrative purposes.

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

                                                                                                                      Needed to address the person correctly.

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

                                                                                                                      Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                                                      ShortOrganization that is associated with the contact
                                                                                                                      Control0..1
                                                                                                                      This element is affected by the following invariants: pat-1
                                                                                                                      TypeReference(Organization)
                                                                                                                      Is Modifierfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

                                                                                                                      For guardians or business related contacts, the organization is relevant.

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

                                                                                                                      The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                                                      ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                                                      Control0..1
                                                                                                                      TypePeriod
                                                                                                                      Is Modifierfalse
                                                                                                                      Summaryfalse
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      532. Patient.communication
                                                                                                                      Definition

                                                                                                                      A language which may be used to communicate with the patient about his or her health.

                                                                                                                      ShortA language which may be used to communicate with the patient about his or her health
                                                                                                                      Comments

                                                                                                                      If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                                                      Control0..*
                                                                                                                      TypeBackboneElement
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

                                                                                                                      If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

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

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

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

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

                                                                                                                      ShortAdditional content defined by implementations
                                                                                                                      Comments

                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                      Control0..*
                                                                                                                      TypeExtension
                                                                                                                      Is Modifierfalse
                                                                                                                      Summaryfalse
                                                                                                                      Alternate Namesextensions, user content
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                      538. Patient.communication.modifierExtension
                                                                                                                      Definition

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

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

                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                      Comments

                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                      Control0..*
                                                                                                                      TypeExtension
                                                                                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                      Summarytrue
                                                                                                                      Requirements

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

                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                      540. Patient.communication.language
                                                                                                                      Definition

                                                                                                                      The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

                                                                                                                      ShortThe language which can be used to communicate with the patient about his or her health
                                                                                                                      Comments

                                                                                                                      The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

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

                                                                                                                      A human language.

                                                                                                                      Additional BindingsPurpose
                                                                                                                      AllLanguagesMax Binding
                                                                                                                      TypeCodeableConcept
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Requirements

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

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

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

                                                                                                                      ShortLanguage preference indicator
                                                                                                                      Comments

                                                                                                                      This language is specifically identified for communicating healthcare information.

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

                                                                                                                      People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

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

                                                                                                                      Patient's nominated care provider.

                                                                                                                      ShortPatient's nominated primary care provider
                                                                                                                      Comments

                                                                                                                      This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. This is not to be used to record Care Teams, these should be recorded on either the CarePlan or EpisodeOfCare resources.

                                                                                                                      Control0..*
                                                                                                                      TypeReference(Practitioner)
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summaryfalse
                                                                                                                      Alternate NamescareProvider
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      546. Patient.managingOrganization
                                                                                                                      Definition

                                                                                                                      Organization that is the custodian of the patient record.

                                                                                                                      ShortOrganization that is the custodian of the patient record
                                                                                                                      Comments

                                                                                                                      There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                                                      Control0..1
                                                                                                                      TypeReference(Organization)
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supportfalse
                                                                                                                      Summarytrue
                                                                                                                      Requirements

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

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

                                                                                                                      Link to another patient resource that concerns the same actual patient.

                                                                                                                      ShortLink to another patient resource that concerns the same actual person
                                                                                                                      Comments

                                                                                                                      There is no assumption that linked patient records have mutual links.

                                                                                                                      Control0..*
                                                                                                                      TypeBackboneElement
                                                                                                                      Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                                                      Summarytrue
                                                                                                                      Requirements

                                                                                                                      There are multiple use cases:

                                                                                                                      • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                                                      • Distribution of patient information across multiple servers.
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      550. Patient.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.

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

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

                                                                                                                      ShortAdditional content defined by implementations
                                                                                                                      Comments

                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                      Control0..*
                                                                                                                      TypeExtension
                                                                                                                      Is Modifierfalse
                                                                                                                      Summaryfalse
                                                                                                                      Alternate Namesextensions, user content
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                      554. Patient.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                      Comments

                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                      Control0..*
                                                                                                                      TypeExtension
                                                                                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                      Summarytrue
                                                                                                                      Requirements

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

                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                      556. Patient.link.other
                                                                                                                      Definition

                                                                                                                      The other patient resource that the link refers to.

                                                                                                                      ShortThe other patient or related person resource that the link refers to
                                                                                                                      Comments

                                                                                                                      Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                                                                                                      Control1..1
                                                                                                                      TypeReference(Patient, RelatedPerson)
                                                                                                                      Is Modifierfalse
                                                                                                                      Summarytrue
                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      558. Patient.link.type
                                                                                                                      Definition

                                                                                                                      The type of link between this patient resource and another patient resource.

                                                                                                                      Shortreplaced-by | replaces | refer | seealso
                                                                                                                      Control1..1
                                                                                                                      BindingThe codes SHALL be taken from LinkType
                                                                                                                      (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                                                                                                                      The type of link between this patient resource and another patient resource.

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