Universal API Implementation Guide
1.1.20 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: UapiBundleCopayEnrollment - Detailed Descriptions

Draft as of 2021-04-28

Definitions for the uapi-copay-enrollment-bundle resource profile.

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

0. Bundle
Definition

A container for a collection of resources.

ShortContains a collection of resources
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsbdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited (entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')))
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited (entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')))
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) ((type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct())
bdl-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
bdl-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
2. Bundle.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

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

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

ShortPersistent identifier for the bundle
Comments

Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Bundle.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.3.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

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

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

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

ShortIssuer's bundle UUID. Genentech will generate UUID if not provided.The value that is unique
Comments

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

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

Indicates the purpose of this bundle - how it is intended to be used.

Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Comments

It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Control1..1
BindingThe codes SHALL be taken from BundleTypehttp://hl7.org/fhir/ValueSet/bundle-type|4.3.0
(required to http://hl7.org/fhir/ValueSet/bundle-type|4.3.0)

Indicates the purpose of a bundle - how it is intended to be used.

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

If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

ShortIf search, the total number of matches
Comments

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Control0..01
This element is affected by the following invariants: bdl-1
TypeunsignedInt
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. Bundle.entry
Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

ShortEntry in the bundle - will have a resource or information
Control70..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
SlicingThis element introduces a set of slices on Bundle.entry. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • type @ resource
  • pattern @ resource.ofType(Organization).type
  • pattern @ resource.ofType(Coverage).type
  • 16. Bundle.entry.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())
    18. Bundle.entry.search
    Definition

    Information about the search process that lead to the creation of this entry.

    ShortSearch related information
    Control0..01
    This element is affected by the following invariants: bdl-2
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    21. Bundle.entry.request
    Definition

    Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

    ShortAdditional execution information (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-3
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    26. Bundle.entry.response
    Definition

    Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

    ShortResults of execution (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-4
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    30. Bundle.entry:messageheader
    Slice Namemessageheader
    Definition

    An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

    ShortEntry in the bundle - will have a resource or information
    Control10..1*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
    bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
    ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    32. Bundle.entry:messageheader.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())
    34. Bundle.entry:messageheader.resource
    Definition

    The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.


    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

    ShortA resource that describes a message that is exchanged between systemsA resource in the bundle
    Control10..1
    TypeMessageHeaderResource(UAPI MessageHeader)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    36. Bundle.entry:messageheader.search
    Definition

    Information about the search process that lead to the creation of this entry.

    ShortSearch related information
    Control0..01
    This element is affected by the following invariants: bdl-2
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    39. Bundle.entry:messageheader.request
    Definition

    Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

    ShortAdditional execution information (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-3
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    44. Bundle.entry:messageheader.response
    Definition

    Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

    ShortResults of execution (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-4
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    48. Bundle.entry:task
    Slice Nametask
    Definition

    An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

    ShortEntry in the bundle - will have a resource or information
    Control10..1*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
    bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
    ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    50. Bundle.entry:task.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())
    52. Bundle.entry:task.resource
    Definition

    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

    ShortA resource in the bundle
    Control10..1
    TypeTaskResource
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    54. Bundle.entry:task.search
    Definition

    Information about the search process that lead to the creation of this entry.

    ShortSearch related information
    Control0..01
    This element is affected by the following invariants: bdl-2
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    57. Bundle.entry:task.request
    Definition

    Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

    ShortAdditional execution information (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-3
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    62. Bundle.entry:task.response
    Definition

    Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

    ShortResults of execution (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-4
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    66. Bundle.entry:list
    Slice Namelist
    Definition

    An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

    ShortEntry in the bundle - will have a resource or information
    Control10..1*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
    bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
    ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    68. Bundle.entry:list.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())
    70. Bundle.entry:list.resource
    Definition

    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

    ShortA resource in the bundle
    Control10..1
    TypeListResource
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    72. Bundle.entry:list.search
    Definition

    Information about the search process that lead to the creation of this entry.

    ShortSearch related information
    Control0..01
    This element is affected by the following invariants: bdl-2
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    75. Bundle.entry:list.request
    Definition

    Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

    ShortAdditional execution information (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-3
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    80. Bundle.entry:list.response
    Definition

    Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

    ShortResults of execution (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-4
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    84. Bundle.entry:patient
    Slice Namepatient
    Definition

    The patient resource being enrolled.


    An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

    ShortPatientEntry in the bundle - will have a resource or information
    Comments

    The patient resource in the data source system.

    Control10..1*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    LabelEnrolled Patient
    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
    bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
    ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    86. Bundle.entry:patient.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())
    88. Bundle.entry:patient.resource
    Definition

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


    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

    ShortInformation about an individual or animal receiving health care servicesA resource in the bundle
    Control10..1
    TypePatientResource(UAPI Patient)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Alternate NamesSubjectOfCare Client Resident
    90. Bundle.entry:patient.search
    Definition

    Information about the search process that lead to the creation of this entry.

    ShortSearch related information
    Control0..01
    This element is affected by the following invariants: bdl-2
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    93. Bundle.entry:patient.request
    Definition

    Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

    ShortAdditional execution information (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-3
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    98. Bundle.entry:patient.response
    Definition

    Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

    ShortResults of execution (transaction/batch/history)
    Control0..01
    This element is affected by the following invariants: bdl-4
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    102. Bundle.entry:practice
    Slice Namepractice
    Definition

    An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

    ShortEntry in the bundle - will have a resource or information
    Control10..1*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
    bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
    ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
    104. Bundle.entry:practice.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())
    106. Bundle.entry:practice.resource
    Definition

    A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.


    The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

    ShortA grouping of people or organizations with a common purposeA resource in the bundle
    Control0..1
    TypeOrganizationResource(UAPI Organization)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    108. Bundle.entry:practice.resource.implicitRules
    Definition

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

    ShortA set of rules under which this content was created
    Comments

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

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

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

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

    ShortExtensions that cannot be ignored
    Comments

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

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

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

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

    Identifier for the organization that is used to identify the organization across multiple disparate systems.

    ShortIdentifier used by Genentech to determine insert vs update operation.Identifies this organization across multiple systems
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..*
    This element is affected by the following invariants: org-1
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    114. Bundle.entry:practice.resource.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.3.0
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    116. Bundle.entry:practice.resource.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
    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()))
    118. Bundle.entry:practice.resource.identifier.value
    Definition

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

    ShortUnique identifier for the organizationThe 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
    Summarytrue
    Example<br/><b>General</b>:123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    120. Bundle.entry:practice.resource.active
    Definition

    Whether the organization's record is still in active use.

    ShortWhether the organization's record is still in active use
    Comments

    This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

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

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

    Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

    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()))
    122. Bundle.entry:practice.resource.type
    Definition

    Only three types of organizations are supported - Provider organization, Insurance organization and Site of Treatment.


    The kind(s) of organization that this is.

    ShortOrganization type for enrollmentKind of organization
    Comments

    Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

    When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

    We expect that some jurisdictions will profile this optionality to be a single cardinality.

    Control10..1*
    BindingThe codes SHALL be taken from For example codes, see UAPI Value Set - Organization Typehttp://hl7.org/fhir/ValueSet/organization-type
    (required to https://fhir.developer.gene.com/ValueSet/uapi-org-type)

    Organization Type Codes


    Used to categorize the organization.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be able to track the kind of organization that this is - different organization types have different uses.

    LabelType of the Organization
    Pattern Value{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/organization-type",
        "code" : "prov"
      }]
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    124. Bundle.entry:practice.resource.name
    Definition

    A name associated with the organization.

    ShortMax 255 CharactersName used for the organization
    Comments

    If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

    Control10..1
    This element is affected by the following invariants: org-1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to use the name as the label of the organization.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    126. Bundle.entry:practice.resource.telecom
    Definition

    A contact detail for the organization.

    ShortA contact detail for the organization
    Comments

    The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

    Control10..*
    This element is affected by the following invariants: org-3
    TypeContactPoint
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Human contact for the organization.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
    SlicingThis element introduces a set of slices on Bundle.entry.resource.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • value @ system
    • 128. Bundle.entry:practice.resource.telecom.system
      Definition

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

      Shortphone | fax | email | pager | url | sms | other
      Control0..1
      This element is affected by the following invariants: cpt-2
      BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      130. Bundle.entry:practice.resource.telecom.value
      Definition

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

      ShortThe actual contact point details
      Comments

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

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      132. Bundle.entry:practice.resource.telecom.use
      Definition

      Identifies the purpose for the contact point.

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

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

      Control0..1
      BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
      (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      134. Bundle.entry:practice.resource.telecom:Phone
      Slice NamePhone
      Definition

      A contact detail for the organization.

      ShortA contact detail for the organization
      Comments

      The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

      Control10..*
      This element is affected by the following invariants: org-3
      TypeContactPoint
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Human contact for the organization.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      136. Bundle.entry:practice.resource.telecom:Phone.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.3.0
      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Fixed Valuephone
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      138. Bundle.entry:practice.resource.telecom:Phone.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).

      ShortPhone (10 digit numeric values only)The actual contact point details
      Comments

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

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      140. Bundle.entry:practice.resource.telecom:Phone.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.3.0
      (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      142. Bundle.entry:practice.resource.telecom:Fax
      Slice NameFax
      Definition

      A contact detail for the organization.

      ShortA contact detail for the organization
      Comments

      The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

      Control0..*
      This element is affected by the following invariants: org-3
      TypeContactPoint
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Human contact for the organization.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      144. Bundle.entry:practice.resource.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.3.0
      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Fixed Valuefax
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      146. Bundle.entry:practice.resource.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).

      ShortFax (10 digit numeric values only)The actual contact point details
      Comments

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

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      148. Bundle.entry:practice.resource.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..1
      BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
      (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      150. Bundle.entry:practice.resource.address
      Definition

      An address for the organization.

      ShortAddress is required for Practice Organization and Site of TreatmentAn address for the organization
      Comments

      Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

      Control0..*
      This element is affected by the following invariants: org-2
      TypeAddress
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
      152. Bundle.entry:practice.resource.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.3.0
      (required to http://hl7.org/fhir/ValueSet/address-use|4.3.0)

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

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

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

      Example<br/><b>General</b>:home
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      154. Bundle.entry:practice.resource.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.

      ShortMax 255 CharactersStreet name, number, direction & P.O. Box etc.
      Control10..3*
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      156. Bundle.entry:practice.resource.address.city
      Definition

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

      ShortMax 30 CharactersName of city, town etc.
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      158. Bundle.entry:practice.resource.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).

      ShortStandard state 2 characters (Ex: CA, AZ, NC..)Sub-unit of country (abbreviations ok)
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate NamesProvince, Territory
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      160. Bundle.entry:practice.resource.address.postalCode
      Definition

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

      ShortMax 10 CharactersPostal code for area
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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()))
      162. Bundle.entry:practice.resource.contact
      Definition

      Contact for the organization for a certain purpose.

      ShortContact is required for Practice OrganizationContact for the organization for a certain purpose
      Comments

      Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Need to keep track of assigned contact points within bigger organization.

      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
      164. Bundle.entry:practice.resource.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())
      166. Bundle.entry:practice.resource.contact.name
      Definition

      A name associated with the contact.

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

      Need to be able to track the person by name.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      168. Bundle.entry:practice.resource.contact.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.3.0
      (required to http://hl7.org/fhir/ValueSet/name-use|4.3.0)
      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      170. Bundle.entry:practice.resource.contact.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.

      ShortMax 40 CharactersFamily name (often called 'Surname')
      Comments

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

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Alternate Namessurname
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      172. Bundle.entry:practice.resource.contact.name.given
      Definition

      Given name.

      ShortMax 80 CharactersGiven 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.

      Control10..1*
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Alternate Namesfirst name, middle name
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      174. Bundle.entry:practice.resource.contact.telecom
      Definition

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

      ShortRequired for Practice OrganizationContact details (telephone, email, etc.) for a contact
      Control10..*
      TypeContactPoint
      Is Modifierfalse
      Must Supporttrue
      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()))
      SlicingThis element introduces a set of slices on Bundle.entry.resource.contact.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • value @ system
      • 176. Bundle.entry:practice.resource.contact.telecom.system
        Definition

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

        Shortphone | fax | email | pager | url | sms | other
        Control0..1
        This element is affected by the following invariants: cpt-2
        BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        178. Bundle.entry:practice.resource.contact.telecom.value
        Definition

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

        ShortThe actual contact point details
        Comments

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

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        180. Bundle.entry:practice.resource.contact.telecom.use
        Definition

        Identifies the purpose for the contact point.

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

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

        Control0..1
        BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        182. Bundle.entry:practice.resource.contact.telecom:Phone
        Slice NamePhone
        Definition

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

        ShortContact details (telephone, email, etc.) for a contact
        Control10..*
        TypeContactPoint
        Is Modifierfalse
        Must Supporttrue
        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()))
        184. Bundle.entry:practice.resource.contact.telecom:Phone.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.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Fixed Valuephone
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        186. Bundle.entry:practice.resource.contact.telecom:Phone.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).

        ShortPhone (10 digit numeric values only)The actual contact point details
        Comments

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

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        188. Bundle.entry:practice.resource.contact.telecom:Phone.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.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        190. Bundle.entry:practice.resource.contact.telecom:Fax
        Slice NameFax
        Definition

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

        ShortContact details (telephone, email, etc.) for a contact
        Control0..*
        TypeContactPoint
        Is Modifierfalse
        Must Supporttrue
        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()))
        192. Bundle.entry:practice.resource.contact.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.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Fixed Valuefax
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        194. Bundle.entry:practice.resource.contact.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).

        ShortFax (10 digit numeric values only)The actual contact point details
        Comments

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

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        196. Bundle.entry:practice.resource.contact.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..1
        BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        198. Bundle.entry:practice.resource.contact.telecom:Email
        Slice NameEmail
        Definition

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

        ShortContact details (telephone, email, etc.) for a contact
        Control0..*
        TypeContactPoint
        Is Modifierfalse
        Must Supporttrue
        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()))
        200. Bundle.entry:practice.resource.contact.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.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Fixed Valueemail
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        202. Bundle.entry:practice.resource.contact.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).

        ShortEmail formatThe actual contact point details
        Comments

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

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        204. Bundle.entry:practice.resource.contact.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.3.0
        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        206. Bundle.entry:practice.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..01
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        209. Bundle.entry:practice.request
        Definition

        Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

        ShortAdditional execution information (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        214. Bundle.entry:practice.response
        Definition

        Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

        ShortResults of execution (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        218. Bundle.entry:practitioner
        Slice Namepractitioner
        Definition

        An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

        ShortEntry in the bundle - will have a resource or information
        Control10..1*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
        ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        220. Bundle.entry:practitioner.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())
        222. Bundle.entry:practitioner.resource
        Definition

        A person who is directly or indirectly involved in the provisioning of healthcare.


        The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

        ShortA person with a formal responsibility in the provisioning of healthcare or related servicesA resource in the bundle
        Control10..1
        TypePractitionerResource(UAPI Practitioner)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        224. Bundle.entry:practitioner.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..01
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        227. Bundle.entry:practitioner.request
        Definition

        Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

        ShortAdditional execution information (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        232. Bundle.entry:practitioner.response
        Definition

        Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

        ShortResults of execution (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        236. Bundle.entry:questionnaireresponse
        Slice Namequestionnaireresponse
        Definition

        An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

        ShortEntry in the bundle - will have a resource or information
        Control10..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
        ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        238. Bundle.entry:questionnaireresponse.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())
        240. Bundle.entry:questionnaireresponse.resource
        Definition

        The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

        ShortA resource in the bundle
        Control10..1
        TypeQuestionnaireResponseResource
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        242. Bundle.entry:questionnaireresponse.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..01
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        245. Bundle.entry:questionnaireresponse.request
        Definition

        Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

        ShortAdditional execution information (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        250. Bundle.entry:questionnaireresponse.response
        Definition

        Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

        ShortResults of execution (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        254. Bundle.entry:medicalCoverage
        Slice NamemedicalCoverage
        Definition

        An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

        ShortEntry in the bundle - will have a resource or information
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
        ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        256. Bundle.entry:medicalCoverage.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())
        258. Bundle.entry:medicalCoverage.resource
        Definition

        Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.


        The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

        ShortInsurance or medical plan or a payment agreementA resource in the bundle
        Comments

        The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

        Control0..1
        TypeCoverageResource(UAPI Coverage)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        260. Bundle.entry:medicalCoverage.resource.implicitRules
        Definition

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

        ShortA set of rules under which this content was created
        Comments

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

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

        Describes Plan year for Coverage Status Outcome

        ShortUAPI Coverage Plan Year
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(UAPI Coverage Plan Year) (Extension Type: string)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        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())
        264. Bundle.entry:medicalCoverage.resource.extension:ReferenceNumber
        Slice NameReferenceNumber
        Definition

        Describes Reference Number for Coverage Status Outcome

        ShortUAPI Coverage Reference Number
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(UAPI Coverage Reference Number) (Extension Type: string)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        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())
        266. Bundle.entry:medicalCoverage.resource.extension:IssuedDate
        Slice NameIssuedDate
        Definition

        Date when the insurance company issued the insurance card.

        ShortUAPI Coverage - Card issuance date
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(UAPI Coverage - Card issuance date) (Extension Type: date)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        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())
        268. Bundle.entry:medicalCoverage.resource.modifierExtension
        Definition

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

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

        ShortExtensions that cannot be ignored
        Comments

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

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

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

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

        The status of the resource instance.

        Shortactive | cancelled | draft | entered-in-error
        Comments

        This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

        Control1..1
        BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.3.0
        (required to http://hl7.org/fhir/ValueSet/fm-status|4.3.0)

        A code specifying the state of the resource instance.

        Typecode
        Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Requirements

        Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        272. Bundle.entry:medicalCoverage.resource.type
        Definition

        The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

        ShortCoverage category such as medical or accident
        Control10..1
        BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type
        (preferred to http://hl7.org/fhir/ValueSet/coverage-type)

        The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        The order of application of coverages is dependent on the types of coverage.

        LabelType of the Coverage
        Pattern Value{
          "coding" : [{
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
            "code" : "HIP"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        274. Bundle.entry:medicalCoverage.resource.subscriber
        Definition

        The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

        ShortSubscriber to the policy
        Comments

        May be self or a parent in the case of dependants.

        Control10..1
        TypeReference(UAPI Patient, UAPI RelatedPerson, Patient, RelatedPerson)
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        This is the party who is entitled to the benfits under the policy.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        276. Bundle.entry:medicalCoverage.resource.subscriberId
        Definition

        The insurer assigned ID for the Subscriber.

        ShortID assigned to the subscriber
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        The insurer requires this identifier on correspondance and claims (digital and otherwise).

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        278. Bundle.entry:medicalCoverage.resource.beneficiary
        Definition

        The party who benefits from the insurance coverage; the patient when products and/or services are provided.

        ShortPlan beneficiary
        Control1..1
        TypeReference(UAPI Patient, Patient)
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        This is the party who receives treatment for which the costs are reimbursed under the coverage.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        280. Bundle.entry:medicalCoverage.resource.beneficiary.type
        Definition

        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

        ShortType the reference refers to (e.g. "Patient")
        Comments

        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
        (extensible to http://hl7.org/fhir/ValueSet/resource-types)
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Pattern ValuePatient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        282. Bundle.entry:medicalCoverage.resource.payor
        Definition

        The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

        ShortIssuer of the policy
        Comments

        May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

        Control1..*
        TypeReference(UAPI Organization, Organization, Patient, RelatedPerson)
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Need to identify the issuer to target for claim processing and for coordination of benefit processing.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        284. Bundle.entry:medicalCoverage.resource.payor.type
        Definition

        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

        ShortType the reference refers to (e.g. "Patient")
        Comments

        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
        (extensible to http://hl7.org/fhir/ValueSet/resource-types)
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Pattern ValueOrganization
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        286. Bundle.entry:medicalCoverage.resource.class
        Definition

        A suite of underwriter specific classifiers.

        ShortAdditional coverage classifications
        Comments

        For example may be used to identify a class of coverage or employer group, Policy, Plan.

        Control10..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

        The codes provided on the health card which identify or confirm the specific policy for the insurer.

        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        288. Bundle.entry:medicalCoverage.resource.class.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())
        290. Bundle.entry:medicalCoverage.resource.class.type
        Definition

        The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

        ShortType of class such as 'group' or 'plan'
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class
        (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

        The policy classifications, eg. Group, Plan, Class, etc.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        The insurer issued label for a specific health card value.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        292. Bundle.entry:medicalCoverage.resource.class.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
        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()))
        294. Bundle.entry:medicalCoverage.resource.class.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
        Summarytrue
        Requirements

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

        Pattern Valuehttp://terminology.hl7.org/CodeSystem/coverage-class
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        296. Bundle.entry:medicalCoverage.resource.class.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
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        298. Bundle.entry:medicalCoverage.resource.class.value
        Definition

        The alphanumeric string value associated with the insurer issued label.

        ShortValue associated with the type
        Comments

        For example, the Group or Plan number.

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

        The insurer issued label and value are necessary to identify the specific policy.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        300. Bundle.entry:medicalCoverage.resource.class.name
        Definition

        A short description for the class.

        ShortHuman readable description of the type and value
        Control10..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Requirements

        Used to provide a meaningful description in correspondence to the patient.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        302. Bundle.entry:medicalCoverage.resource.order
        Definition

        The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

        ShortRelative order of the coverage
        Control10..1
        TypepositiveInt
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Used in managing the coordination of benefits.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        304. Bundle.entry:medicalCoverage.resource.network
        Definition

        The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

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

        Used in referral for treatment and in claims processing.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        306. Bundle.entry:medicalCoverage.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..01
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        309. Bundle.entry:medicalCoverage.request
        Definition

        Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

        ShortAdditional execution information (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        314. Bundle.entry:medicalCoverage.response
        Definition

        Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

        ShortResults of execution (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        318. Bundle.entry:pharmacyCoverage
        Slice NamepharmacyCoverage
        Definition

        An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

        ShortEntry in the bundle - will have a resource or information
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
        ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        320. Bundle.entry:pharmacyCoverage.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())
        322. Bundle.entry:pharmacyCoverage.resource
        Definition

        Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.


        The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

        ShortInsurance or medical plan or a payment agreementA resource in the bundle
        Comments

        The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

        Control0..1
        TypeCoverageResource(UAPI Coverage)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        324. Bundle.entry:pharmacyCoverage.resource.implicitRules
        Definition

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

        ShortA set of rules under which this content was created
        Comments

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

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

        Describes Plan year for Coverage Status Outcome

        ShortUAPI Coverage Plan Year
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(UAPI Coverage Plan Year) (Extension Type: string)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        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())
        328. Bundle.entry:pharmacyCoverage.resource.extension:ReferenceNumber
        Slice NameReferenceNumber
        Definition

        Describes Reference Number for Coverage Status Outcome

        ShortUAPI Coverage Reference Number
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(UAPI Coverage Reference Number) (Extension Type: string)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        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())
        330. Bundle.entry:pharmacyCoverage.resource.extension:IssuedDate
        Slice NameIssuedDate
        Definition

        Date when the insurance company issued the insurance card.

        ShortUAPI Coverage - Card issuance date
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(UAPI Coverage - Card issuance date) (Extension Type: date)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        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())
        332. Bundle.entry:pharmacyCoverage.resource.modifierExtension
        Definition

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

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

        ShortExtensions that cannot be ignored
        Comments

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

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

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

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

        The status of the resource instance.

        Shortactive | cancelled | draft | entered-in-error
        Comments

        This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

        Control1..1
        BindingThe codes SHALL be taken from FinancialResourceStatusCodeshttp://hl7.org/fhir/ValueSet/fm-status|4.3.0
        (required to http://hl7.org/fhir/ValueSet/fm-status|4.3.0)

        A code specifying the state of the resource instance.

        Typecode
        Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Requirements

        Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        336. Bundle.entry:pharmacyCoverage.resource.type
        Definition

        The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

        ShortCoverage category such as medical or accident
        Control10..1
        BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodeshttp://hl7.org/fhir/ValueSet/coverage-type
        (preferred to http://hl7.org/fhir/ValueSet/coverage-type)

        The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        The order of application of coverages is dependent on the types of coverage.

        LabelType of the Coverage
        Pattern Value{
          "coding" : [{
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
            "code" : "DRUGPOL"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        338. Bundle.entry:pharmacyCoverage.resource.subscriber
        Definition

        The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

        ShortSubscriber to the policy
        Comments

        May be self or a parent in the case of dependants.

        Control10..1
        TypeReference(UAPI Patient, UAPI RelatedPerson, Patient, RelatedPerson)
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        This is the party who is entitled to the benfits under the policy.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        340. Bundle.entry:pharmacyCoverage.resource.subscriberId
        Definition

        The insurer assigned ID for the Subscriber.

        ShortID assigned to the subscriber
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        The insurer requires this identifier on correspondance and claims (digital and otherwise).

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        342. Bundle.entry:pharmacyCoverage.resource.beneficiary
        Definition

        The party who benefits from the insurance coverage; the patient when products and/or services are provided.

        ShortPlan beneficiary
        Control1..1
        TypeReference(UAPI Patient, Patient)
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        This is the party who receives treatment for which the costs are reimbursed under the coverage.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        344. Bundle.entry:pharmacyCoverage.resource.beneficiary.type
        Definition

        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

        ShortType the reference refers to (e.g. "Patient")
        Comments

        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
        (extensible to http://hl7.org/fhir/ValueSet/resource-types)
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Pattern ValuePatient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        346. Bundle.entry:pharmacyCoverage.resource.payor
        Definition

        The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

        ShortIssuer of the policy
        Comments

        May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

        Control1..*
        TypeReference(UAPI Organization, Organization, Patient, RelatedPerson)
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Need to identify the issuer to target for claim processing and for coordination of benefit processing.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        348. Bundle.entry:pharmacyCoverage.resource.payor.type
        Definition

        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

        ShortType the reference refers to (e.g. "Patient")
        Comments

        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
        (extensible to http://hl7.org/fhir/ValueSet/resource-types)
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Pattern ValueOrganization
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        350. Bundle.entry:pharmacyCoverage.resource.class
        Definition

        A suite of underwriter specific classifiers.

        ShortAdditional coverage classifications
        Comments

        For example may be used to identify a class of coverage or employer group, Policy, Plan.

        Control10..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

        The codes provided on the health card which identify or confirm the specific policy for the insurer.

        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        352. Bundle.entry:pharmacyCoverage.resource.class.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())
        354. Bundle.entry:pharmacyCoverage.resource.class.type
        Definition

        The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

        ShortType of class such as 'group' or 'plan'
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodeshttp://hl7.org/fhir/ValueSet/coverage-class
        (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

        The policy classifications, eg. Group, Plan, Class, etc.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        The insurer issued label for a specific health card value.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        356. Bundle.entry:pharmacyCoverage.resource.class.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
        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()))
        358. Bundle.entry:pharmacyCoverage.resource.class.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
        Summarytrue
        Requirements

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

        Pattern Valuehttp://terminology.hl7.org/CodeSystem/coverage-class
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        360. Bundle.entry:pharmacyCoverage.resource.class.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
        Summarytrue
        Requirements

        Need to refer to a particular code in the system.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        362. Bundle.entry:pharmacyCoverage.resource.class.value
        Definition

        The alphanumeric string value associated with the insurer issued label.

        ShortValue associated with the type
        Comments

        For example, the Group or Plan number.

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

        The insurer issued label and value are necessary to identify the specific policy.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        364. Bundle.entry:pharmacyCoverage.resource.class.name
        Definition

        A short description for the class.

        ShortHuman readable description of the type and value
        Control10..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Requirements

        Used to provide a meaningful description in correspondence to the patient.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        366. Bundle.entry:pharmacyCoverage.resource.order
        Definition

        The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

        ShortRelative order of the coverage
        Control10..1
        TypepositiveInt
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Used in managing the coordination of benefits.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        368. Bundle.entry:pharmacyCoverage.resource.network
        Definition

        The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

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

        Used in referral for treatment and in claims processing.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        370. Bundle.entry:pharmacyCoverage.search
        Definition

        Information about the search process that lead to the creation of this entry.

        ShortSearch related information
        Control0..01
        This element is affected by the following invariants: bdl-2
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        373. Bundle.entry:pharmacyCoverage.request
        Definition

        Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

        ShortAdditional execution information (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-3
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        378. Bundle.entry:pharmacyCoverage.response
        Definition

        Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

        ShortResults of execution (transaction/batch/history)
        Control0..01
        This element is affected by the following invariants: bdl-4
        TypeBackboneElement
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        382. Bundle.entry:payer
        Slice Namepayer
        Definition

        An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

        ShortEntry in the bundle - will have a resource or information
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
        bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
        ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
        384. Bundle.entry:payer.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())
        386. Bundle.entry:payer.resource
        Definition

        A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.


        The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

        ShortA grouping of people or organizations with a common purposeA resource in the bundle
        Control0..1
        TypeOrganizationResource(UAPI Organization)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        388. Bundle.entry:payer.resource.implicitRules
        Definition

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

        ShortA set of rules under which this content was created
        Comments

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

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

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

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

        ShortExtensions that cannot be ignored
        Comments

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

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

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

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

        Identifier for the organization that is used to identify the organization across multiple disparate systems.

        ShortIdentifier used by Genentech to determine insert vs update operation.Identifies this organization across multiple systems
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control10..*
        This element is affected by the following invariants: org-1
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        394. Bundle.entry:payer.resource.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.3.0
        (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
        Typecode
        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        396. Bundle.entry:payer.resource.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
        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()))
        398. Bundle.entry:payer.resource.identifier.value
        Definition

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

        ShortUnique identifier for the organizationThe 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
        Summarytrue
        Example<br/><b>General</b>:123456
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        400. Bundle.entry:payer.resource.active
        Definition

        Whether the organization's record is still in active use.

        ShortWhether the organization's record is still in active use
        Comments

        This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

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

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

        Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

        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()))
        402. Bundle.entry:payer.resource.type
        Definition

        Only three types of organizations are supported - Provider organization, Insurance organization and Site of Treatment.


        The kind(s) of organization that this is.

        ShortOrganization type for enrollmentKind of organization
        Comments

        Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

        When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

        We expect that some jurisdictions will profile this optionality to be a single cardinality.

        Control10..1*
        BindingThe codes SHALL be taken from For example codes, see UAPI Value Set - Organization Typehttp://hl7.org/fhir/ValueSet/organization-type
        (required to https://fhir.developer.gene.com/ValueSet/uapi-org-type)

        Organization Type Codes


        Used to categorize the organization.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Need to be able to track the kind of organization that this is - different organization types have different uses.

        LabelType of the Organization
        Pattern Value{
          "coding" : [{
            "system" : "http://terminology.hl7.org/CodeSystem/organization-type",
            "code" : "ins"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        404. Bundle.entry:payer.resource.name
        Definition

        A name associated with the organization.

        ShortMax 255 CharactersName used for the organization
        Comments

        If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

        Control10..1
        This element is affected by the following invariants: org-1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Need to use the name as the label of the organization.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        406. Bundle.entry:payer.resource.telecom
        Definition

        A contact detail for the organization.

        ShortA contact detail for the organization
        Comments

        The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

        Control10..*
        This element is affected by the following invariants: org-3
        TypeContactPoint
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Requirements

        Human contact for the organization.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
        SlicingThis element introduces a set of slices on Bundle.entry.resource.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
        • value @ system
        • 408. Bundle.entry:payer.resource.telecom.system
          Definition

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

          Shortphone | fax | email | pager | url | sms | other
          Control0..1
          This element is affected by the following invariants: cpt-2
          BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          410. Bundle.entry:payer.resource.telecom.value
          Definition

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

          ShortThe actual contact point details
          Comments

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

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          412. Bundle.entry:payer.resource.telecom.use
          Definition

          Identifies the purpose for the contact point.

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

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

          Control0..1
          BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          414. Bundle.entry:payer.resource.telecom:Phone
          Slice NamePhone
          Definition

          A contact detail for the organization.

          ShortA contact detail for the organization
          Comments

          The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

          Control10..*
          This element is affected by the following invariants: org-3
          TypeContactPoint
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          Human contact for the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
          416. Bundle.entry:payer.resource.telecom:Phone.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.3.0
          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Fixed Valuephone
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          418. Bundle.entry:payer.resource.telecom:Phone.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).

          ShortPhone (10 digit numeric values only)The actual contact point details
          Comments

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

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          420. Bundle.entry:payer.resource.telecom:Phone.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.3.0
          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          422. Bundle.entry:payer.resource.telecom:Fax
          Slice NameFax
          Definition

          A contact detail for the organization.

          ShortA contact detail for the organization
          Comments

          The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

          Control0..*
          This element is affected by the following invariants: org-3
          TypeContactPoint
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          Human contact for the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
          424. Bundle.entry:payer.resource.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.3.0
          (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Fixed Valuefax
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          426. Bundle.entry:payer.resource.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).

          ShortFax (10 digit numeric values only)The actual contact point details
          Comments

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

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          428. Bundle.entry:payer.resource.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..1
          BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          430. Bundle.entry:payer.resource.address
          Definition

          An address for the organization.

          ShortAddress is required for Practice Organization and Site of TreatmentAn address for the organization
          Comments

          Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

          Control0..*
          This element is affected by the following invariants: org-2
          TypeAddress
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
          432. Bundle.entry:payer.resource.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.3.0
          (required to http://hl7.org/fhir/ValueSet/address-use|4.3.0)

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

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

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

          Example<br/><b>General</b>:home
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          434. Bundle.entry:payer.resource.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.

          ShortMax 255 CharactersStreet name, number, direction & P.O. Box etc.
          Control10..3*
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          436. Bundle.entry:payer.resource.address.city
          Definition

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

          ShortMax 30 CharactersName of city, town etc.
          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          438. Bundle.entry:payer.resource.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).

          ShortStandard state 2 characters (Ex: CA, AZ, NC..)Sub-unit of country (abbreviations ok)
          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesProvince, Territory
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          440. Bundle.entry:payer.resource.address.postalCode
          Definition

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

          ShortMax 10 CharactersPostal code for area
          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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()))
          442. Bundle.entry:payer.resource.contact
          Definition

          Contact for the organization for a certain purpose.

          ShortContact is required for Practice OrganizationContact for the organization for a certain purpose
          Comments

          Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          Need to keep track of assigned contact points within bigger organization.

          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
          444. Bundle.entry:payer.resource.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())
          446. Bundle.entry:payer.resource.contact.name
          Definition

          A name associated with the contact.

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

          Need to be able to track the person by name.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          448. Bundle.entry:payer.resource.contact.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.3.0
          (required to http://hl7.org/fhir/ValueSet/name-use|4.3.0)
          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          450. Bundle.entry:payer.resource.contact.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.

          ShortMax 40 CharactersFamily name (often called 'Surname')
          Comments

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

          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Alternate Namessurname
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          452. Bundle.entry:payer.resource.contact.name.given
          Definition

          Given name.

          ShortMax 80 CharactersGiven 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.

          Control10..1*
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Alternate Namesfirst name, middle name
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          454. Bundle.entry:payer.resource.contact.telecom
          Definition

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

          ShortRequired for Practice OrganizationContact details (telephone, email, etc.) for a contact
          Control10..*
          TypeContactPoint
          Is Modifierfalse
          Must Supporttrue
          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()))
          SlicingThis element introduces a set of slices on Bundle.entry.resource.contact.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • value @ system
          • 456. Bundle.entry:payer.resource.contact.telecom.system
            Definition

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

            Shortphone | fax | email | pager | url | sms | other
            Control0..1
            This element is affected by the following invariants: cpt-2
            BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            458. Bundle.entry:payer.resource.contact.telecom.value
            Definition

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

            ShortThe actual contact point details
            Comments

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

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            460. Bundle.entry:payer.resource.contact.telecom.use
            Definition

            Identifies the purpose for the contact point.

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

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

            Control0..1
            BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            462. Bundle.entry:payer.resource.contact.telecom:Phone
            Slice NamePhone
            Definition

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

            ShortContact details (telephone, email, etc.) for a contact
            Control10..*
            TypeContactPoint
            Is Modifierfalse
            Must Supporttrue
            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()))
            464. Bundle.entry:payer.resource.contact.telecom:Phone.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.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Fixed Valuephone
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            466. Bundle.entry:payer.resource.contact.telecom:Phone.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).

            ShortPhone (10 digit numeric values only)The actual contact point details
            Comments

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

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            468. Bundle.entry:payer.resource.contact.telecom:Phone.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.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            470. Bundle.entry:payer.resource.contact.telecom:Fax
            Slice NameFax
            Definition

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

            ShortContact details (telephone, email, etc.) for a contact
            Control0..*
            TypeContactPoint
            Is Modifierfalse
            Must Supporttrue
            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()))
            472. Bundle.entry:payer.resource.contact.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.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Fixed Valuefax
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            474. Bundle.entry:payer.resource.contact.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).

            ShortFax (10 digit numeric values only)The actual contact point details
            Comments

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

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            476. Bundle.entry:payer.resource.contact.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..1
            BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            478. Bundle.entry:payer.resource.contact.telecom:Email
            Slice NameEmail
            Definition

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

            ShortContact details (telephone, email, etc.) for a contact
            Control0..*
            TypeContactPoint
            Is Modifierfalse
            Must Supporttrue
            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()))
            480. Bundle.entry:payer.resource.contact.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.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Fixed Valueemail
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            482. Bundle.entry:payer.resource.contact.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).

            ShortEmail formatThe actual contact point details
            Comments

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

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            484. Bundle.entry:payer.resource.contact.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.3.0
            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            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()))
            486. Bundle.entry:payer.search
            Definition

            Information about the search process that lead to the creation of this entry.

            ShortSearch related information
            Control0..01
            This element is affected by the following invariants: bdl-2
            TypeBackboneElement
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
            489. Bundle.entry:payer.request
            Definition

            Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

            ShortAdditional execution information (transaction/batch/history)
            Control0..01
            This element is affected by the following invariants: bdl-3
            TypeBackboneElement
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
            494. Bundle.entry:payer.response
            Definition

            Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

            ShortResults of execution (transaction/batch/history)
            Control0..01
            This element is affected by the following invariants: bdl-4
            TypeBackboneElement
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

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

            0. Bundle
            2. Bundle.identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control1..?
            4. Bundle.identifier.type
            6. Bundle.identifier.type.coding
            8. Bundle.identifier.type.coding.system
            Control1..?
            Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
            10. Bundle.identifier.type.coding.code
            Control1..?
            Pattern ValueRI
            12. Bundle.identifier.value
            ShortIssuer's bundle UUID. Genentech will generate UUID if not provided.
            14. Bundle.type
            Must Supporttrue
            Fixed Valuemessage
            16. Bundle.total
            Control0..0
            18. Bundle.entry
            Control7..?
            Must Supporttrue
            SlicingThis element introduces a set of slices on Bundle.entry. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
            • type @ resource
            • pattern @ resource.ofType(Organization).type
            • pattern @ resource.ofType(Coverage).type
            • 20. Bundle.entry.search
              Control0..0
              22. Bundle.entry.request
              Control0..0
              24. Bundle.entry.response
              Control0..0
              26. Bundle.entry:messageheader
              Slice Namemessageheader
              Control1..1
              Must Supporttrue
              28. Bundle.entry:messageheader.resource
              Control1..?
              TypeMessageHeader(UAPI MessageHeader)
              Must Supporttrue
              30. Bundle.entry:task
              Slice Nametask
              Control1..1
              Must Supporttrue
              32. Bundle.entry:task.resource
              Control1..?
              TypeTask
              Must Supporttrue
              34. Bundle.entry:list
              Slice Namelist
              Control1..1
              Must Supporttrue
              36. Bundle.entry:list.resource
              Control1..?
              TypeList
              Must Supporttrue
              38. Bundle.entry:patient
              Slice Namepatient
              Definition

              The patient resource being enrolled.

              ShortPatient
              Comments

              The patient resource in the data source system.

              Control1..1
              Must Supporttrue
              LabelEnrolled Patient
              40. Bundle.entry:patient.resource
              Control1..?
              TypePatient(UAPI Patient)
              Must Supporttrue
              42. Bundle.entry:practice
              Slice Namepractice
              Control1..1
              Must Supporttrue
              44. Bundle.entry:practice.resource
              TypeOrganization(UAPI Organization)
              46. Bundle.entry:practice.resource.type
              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/organization-type",
                  "code" : "prov"
                }]
              }
              48. Bundle.entry:practitioner
              Slice Namepractitioner
              Control1..1
              Must Supporttrue
              50. Bundle.entry:practitioner.resource
              Control1..?
              TypePractitioner(UAPI Practitioner)
              Must Supporttrue
              52. Bundle.entry:questionnaireresponse
              Slice Namequestionnaireresponse
              Control1..*
              Must Supporttrue
              54. Bundle.entry:questionnaireresponse.resource
              Control1..?
              TypeQuestionnaireResponse
              Must Supporttrue
              56. Bundle.entry:medicalCoverage
              Slice NamemedicalCoverage
              Control0..*
              Must Supporttrue
              58. Bundle.entry:medicalCoverage.resource
              TypeCoverage(UAPI Coverage)
              Must Supporttrue
              60. Bundle.entry:medicalCoverage.resource.type
              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                  "code" : "HIP"
                }]
              }
              62. Bundle.entry:pharmacyCoverage
              Slice NamepharmacyCoverage
              Control0..*
              Must Supporttrue
              64. Bundle.entry:pharmacyCoverage.resource
              TypeCoverage(UAPI Coverage)
              Must Supporttrue
              66. Bundle.entry:pharmacyCoverage.resource.type
              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                  "code" : "DRUGPOL"
                }]
              }
              68. Bundle.entry:payer
              Slice Namepayer
              Control0..*
              Must Supporttrue
              70. Bundle.entry:payer.resource
              TypeOrganization(UAPI Organization)
              Must Supporttrue
              72. Bundle.entry:payer.resource.type
              Pattern Value{
                "coding" : [{
                  "system" : "http://terminology.hl7.org/CodeSystem/organization-type",
                  "code" : "ins"
                }]
              }

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

              0. Bundle
              Definition

              A container for a collection of resources.

              ShortContains a collection of resources
              Control0..*
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Invariantsbdl-1: total only when a search or history (total.empty() or (type = 'searchset') or (type = 'history'))
              bdl-2: entry.search only when a search (entry.search.empty() or (type = 'searchset'))
              bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited (entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')))
              bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited (entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')))
              bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) ((type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct())
              bdl-9: A document must have an identifier with a system and a value (type = 'document' implies (identifier.system.exists() and identifier.value.exists()))
              bdl-10: A document must have a date (type = 'document' implies (timestamp.hasValue()))
              bdl-11: A document must have a Composition as the first resource (type = 'document' implies entry.first().resource.is(Composition))
              bdl-12: A message must have a MessageHeader as the first resource (type = 'message' implies entry.first().resource.is(MessageHeader))
              2. Bundle.id
              Definition

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

              ShortLogical id of this artifact
              Comments

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

              Control0..1
              Typeid
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              4. Bundle.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. Bundle.implicitRules
              Definition

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

              ShortA set of rules under which this content was created
              Comments

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

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

              IETF language tag

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

              A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

              ShortPersistent identifier for the bundle
              Comments

              Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control1..1
              TypeIdentifier
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. Bundle.identifier.id
              Definition

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

              ShortUnique id for inter-element referencing
              Control0..1
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              14. Bundle.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 Bundle.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. Bundle.identifier.use
                Definition

                The purpose of this identifier.

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

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

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

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                18. Bundle.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)
                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Requirements

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

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                20. Bundle.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
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                22. Bundle.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 Bundle.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 24. Bundle.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.

                  Control0..*
                  TypeCoding
                  Is Modifierfalse
                  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()))
                  26. Bundle.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
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  28. Bundle.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 Bundle.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 30. Bundle.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
                    Summarytrue
                    Requirements

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

                    Pattern Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    32. Bundle.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()))
                    34. Bundle.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
                    Summarytrue
                    Requirements

                    Need to refer to a particular code in the system.

                    Pattern ValueRI
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. Bundle.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()))
                    38. Bundle.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()))
                    40. Bundle.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()))
                    42. Bundle.identifier.system
                    Definition

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

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

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

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

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

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

                    ShortIssuer's bundle UUID. Genentech will generate UUID if not provided.
                    Comments

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

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

                    Indicates the purpose of this bundle - how it is intended to be used.

                    Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
                    Comments

                    It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

                    Control1..1
                    BindingThe codes SHALL be taken from BundleType
                    (required to http://hl7.org/fhir/ValueSet/bundle-type|4.3.0)

                    Indicates the purpose of a bundle - how it is intended to be used.

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

                    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

                    ShortWhen the bundle was assembled
                    Comments

                    For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

                    Usage:

                    • document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
                    • message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
                    • history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
                    • searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
                    • transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

                    The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

                    Control0..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()))
                    54. Bundle.total
                    Definition

                    If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

                    ShortIf search, the total number of matches
                    Comments

                    Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

                    Control0..0
                    This element is affected by the following invariants: bdl-1
                    TypeunsignedInt
                    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()))
                    56. Bundle.link
                    Definition

                    A series of links that provide context to this bundle.

                    ShortLinks related to this Bundle
                    Comments

                    Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

                    Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

                    This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

                    Control0..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                    58. Bundle.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
                    60. Bundle.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())
                    62. Bundle.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())
                    64. Bundle.link.relation
                    Definition

                    A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1.

                    ShortSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
                    Control1..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()))
                    66. Bundle.link.url
                    Definition

                    The reference details for the link.

                    ShortReference details for the link
                    Control1..1
                    Typeuri
                    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()))
                    68. Bundle.entry
                    Definition

                    An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                    ShortEntry in the bundle - will have a resource or information
                    Control7..*
                    TypeBackboneElement
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                    bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                    ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                    SlicingThis element introduces a set of slices on Bundle.entry. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                    • type @ resource
                    • pattern @ resource.ofType(Organization).type
                    • pattern @ resource.ofType(Coverage).type
                    • 70. Bundle.entry.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
                      72. Bundle.entry.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())
                      74. Bundle.entry.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())
                      76. Bundle.entry.link
                      Definition

                      A series of links that provide context to this entry.

                      ShortLinks related to this entry
                      Control0..*
                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      78. Bundle.entry.fullUrl
                      Definition

                      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                      • Results from operations might involve resources that are not identified.
                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                      Comments

                      fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                      Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                      Control0..1
                      Typeuri
                      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()))
                      80. Bundle.entry.resource
                      Definition

                      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                      ShortA resource in the bundle
                      Control0..1
                      TypeResource
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      82. Bundle.entry.search
                      Definition

                      Information about the search process that lead to the creation of this entry.

                      ShortSearch related information
                      Control0..0
                      This element is affected by the following invariants: bdl-2
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      89. Bundle.entry.request
                      Definition

                      Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                      ShortAdditional execution information (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-3
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      100. Bundle.entry.response
                      Definition

                      Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                      ShortResults of execution (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-4
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      110. Bundle.entry:messageheader
                      Slice Namemessageheader
                      Definition

                      An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                      ShortEntry in the bundle - will have a resource or information
                      Control1..1
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                      ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      112. Bundle.entry:messageheader.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
                      114. Bundle.entry:messageheader.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())
                      116. Bundle.entry:messageheader.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())
                      118. Bundle.entry:messageheader.link
                      Definition

                      A series of links that provide context to this entry.

                      ShortLinks related to this entry
                      Control0..*
                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      120. Bundle.entry:messageheader.fullUrl
                      Definition

                      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                      • Results from operations might involve resources that are not identified.
                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                      Comments

                      fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                      Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                      Control0..1
                      Typeuri
                      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()))
                      122. Bundle.entry:messageheader.resource
                      Definition

                      The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

                      ShortA resource that describes a message that is exchanged between systems
                      Control1..1
                      TypeMessageHeader(UAPI MessageHeader)
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      124. Bundle.entry:messageheader.search
                      Definition

                      Information about the search process that lead to the creation of this entry.

                      ShortSearch related information
                      Control0..0
                      This element is affected by the following invariants: bdl-2
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      131. Bundle.entry:messageheader.request
                      Definition

                      Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                      ShortAdditional execution information (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-3
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      142. Bundle.entry:messageheader.response
                      Definition

                      Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                      ShortResults of execution (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-4
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      152. Bundle.entry:task
                      Slice Nametask
                      Definition

                      An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                      ShortEntry in the bundle - will have a resource or information
                      Control1..1
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                      ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      154. Bundle.entry:task.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
                      156. Bundle.entry:task.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())
                      158. Bundle.entry:task.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())
                      160. Bundle.entry:task.link
                      Definition

                      A series of links that provide context to this entry.

                      ShortLinks related to this entry
                      Control0..*
                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      162. Bundle.entry:task.fullUrl
                      Definition

                      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                      • Results from operations might involve resources that are not identified.
                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                      Comments

                      fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                      Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                      Control0..1
                      Typeuri
                      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()))
                      164. Bundle.entry:task.resource
                      Definition

                      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                      ShortA resource in the bundle
                      Control1..1
                      TypeTask
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      166. Bundle.entry:task.search
                      Definition

                      Information about the search process that lead to the creation of this entry.

                      ShortSearch related information
                      Control0..0
                      This element is affected by the following invariants: bdl-2
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      173. Bundle.entry:task.request
                      Definition

                      Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                      ShortAdditional execution information (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-3
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      184. Bundle.entry:task.response
                      Definition

                      Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                      ShortResults of execution (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-4
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      194. Bundle.entry:list
                      Slice Namelist
                      Definition

                      An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                      ShortEntry in the bundle - will have a resource or information
                      Control1..1
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                      ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      196. Bundle.entry:list.id
                      Definition

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

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

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

                      ShortAdditional content defined by implementations
                      Comments

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

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      200. Bundle.entry:list.modifierExtension
                      Definition

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

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

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

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

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

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

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

                      A series of links that provide context to this entry.

                      ShortLinks related to this entry
                      Control0..*
                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      204. Bundle.entry:list.fullUrl
                      Definition

                      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                      • Results from operations might involve resources that are not identified.
                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                      Comments

                      fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                      Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                      Control0..1
                      Typeuri
                      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()))
                      206. Bundle.entry:list.resource
                      Definition

                      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                      ShortA resource in the bundle
                      Control1..1
                      TypeList
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      208. Bundle.entry:list.search
                      Definition

                      Information about the search process that lead to the creation of this entry.

                      ShortSearch related information
                      Control0..0
                      This element is affected by the following invariants: bdl-2
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      215. Bundle.entry:list.request
                      Definition

                      Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                      ShortAdditional execution information (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-3
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      226. Bundle.entry:list.response
                      Definition

                      Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                      ShortResults of execution (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-4
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      236. Bundle.entry:patient
                      Slice Namepatient
                      Definition

                      The patient resource being enrolled.

                      ShortPatient
                      Comments

                      The patient resource in the data source system.

                      Control1..1
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      LabelEnrolled Patient
                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                      ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      238. Bundle.entry:patient.id
                      Definition

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

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      240. Bundle.entry:patient.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())
                      242. Bundle.entry:patient.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())
                      244. Bundle.entry:patient.link
                      Definition

                      A series of links that provide context to this entry.

                      ShortLinks related to this entry
                      Control0..*
                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      246. Bundle.entry:patient.fullUrl
                      Definition

                      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                      • Results from operations might involve resources that are not identified.
                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                      Comments

                      fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                      Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                      Control0..1
                      Typeuri
                      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()))
                      248. Bundle.entry:patient.resource
                      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
                      Control1..1
                      TypePatient(UAPI Patient)
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Alternate NamesSubjectOfCare Client Resident
                      250. Bundle.entry:patient.search
                      Definition

                      Information about the search process that lead to the creation of this entry.

                      ShortSearch related information
                      Control0..0
                      This element is affected by the following invariants: bdl-2
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      257. Bundle.entry:patient.request
                      Definition

                      Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                      ShortAdditional execution information (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-3
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      268. Bundle.entry:patient.response
                      Definition

                      Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                      ShortResults of execution (transaction/batch/history)
                      Control0..0
                      This element is affected by the following invariants: bdl-4
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      278. Bundle.entry:practice
                      Slice Namepractice
                      Definition

                      An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                      ShortEntry in the bundle - will have a resource or information
                      Control1..1
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                      ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                      280. Bundle.entry:practice.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
                      282. Bundle.entry:practice.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())
                      284. Bundle.entry:practice.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())
                      286. Bundle.entry:practice.link
                      Definition

                      A series of links that provide context to this entry.

                      ShortLinks related to this entry
                      Control0..*
                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      288. Bundle.entry:practice.fullUrl
                      Definition

                      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                      • Results from operations might involve resources that are not identified.
                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                      Comments

                      fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                      Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                      Control0..1
                      Typeuri
                      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()))
                      290. Bundle.entry:practice.resource
                      Definition

                      A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                      ShortA grouping of people or organizations with a common purpose
                      Control0..1
                      TypeOrganization(UAPI Organization)
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      292. Bundle.entry:practice.resource.id
                      Definition

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

                      ShortLogical id of this artifact
                      Comments

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

                      Control0..1
                      Typeid
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      294. Bundle.entry:practice.resource.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()))
                      296. Bundle.entry:practice.resource.implicitRules
                      Definition

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

                      ShortA set of rules under which this content was created
                      Comments

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

                      Control0..1
                      Typeuri
                      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      298. Bundle.entry:practice.resource.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)

                      IETF language tag

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

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

                      ShortText summary of the resource, for human interpretation
                      Comments

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

                      Control0..1
                      TypeNarrative
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Alternate Namesnarrative, html, xhtml, display
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      302. Bundle.entry:practice.resource.contained
                      Definition

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

                      ShortContained, inline Resources
                      Comments

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

                      Control0..*
                      TypeResource
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Alternate Namesinline resources, anonymous resources, contained resources
                      Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                      304. Bundle.entry:practice.resource.extension
                      Definition

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

                      ShortAdditional content defined by implementations
                      Comments

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

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      306. Bundle.entry:practice.resource.modifierExtension
                      Definition

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

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

                      ShortExtensions that cannot be ignored
                      Comments

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

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

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

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

                      Identifier for the organization that is used to identify the organization across multiple disparate systems.

                      ShortIdentifier used by Genentech to determine insert vs update operation.
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control1..*
                      This element is affected by the following invariants: org-1
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      310. Bundle.entry:practice.resource.identifier.id
                      Definition

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

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      312. Bundle.entry:practice.resource.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 Bundle.entry.resource.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 314. Bundle.entry:practice.resource.identifier.use
                        Definition

                        The purpose of this identifier.

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

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

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

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

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        316. Bundle.entry:practice.resource.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)
                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Requirements

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

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        318. Bundle.entry:practice.resource.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
                        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()))
                        320. Bundle.entry:practice.resource.identifier.value
                        Definition

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

                        ShortUnique identifier for the organization
                        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
                        Summarytrue
                        Example<br/><b>General</b>:123456
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        322. Bundle.entry:practice.resource.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()))
                        324. Bundle.entry:practice.resource.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()))
                        326. Bundle.entry:practice.resource.active
                        Definition

                        Whether the organization's record is still in active use.

                        ShortWhether the organization's record is still in active use
                        Comments

                        This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

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

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

                        Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

                        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()))
                        328. Bundle.entry:practice.resource.type
                        Definition

                        Only three types of organizations are supported - Provider organization, Insurance organization and Site of Treatment.

                        ShortOrganization type for enrollment
                        Comments

                        Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

                        When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

                        We expect that some jurisdictions will profile this optionality to be a single cardinality.

                        Control1..1
                        BindingThe codes SHALL be taken from UAPI Value Set - Organization Type
                        (required to https://fhir.developer.gene.com/ValueSet/uapi-org-type)

                        Organization Type Codes

                        TypeCodeableConcept
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to be able to track the kind of organization that this is - different organization types have different uses.

                        LabelType of the Organization
                        Pattern Value{
                          "coding" : [{
                            "system" : "http://terminology.hl7.org/CodeSystem/organization-type",
                            "code" : "prov"
                          }]
                        }
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        330. Bundle.entry:practice.resource.name
                        Definition

                        A name associated with the organization.

                        ShortMax 255 Characters
                        Comments

                        If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

                        Control1..1
                        This element is affected by the following invariants: org-1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to use the name as the label of the organization.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        332. Bundle.entry:practice.resource.alias
                        Definition

                        A list of alternate names that the organization is known as, or was known as in the past.

                        ShortA list of alternate names that the organization is known as, or was known as in the past
                        Comments

                        There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

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

                        Over time locations and organizations go through many changes and can be known by different names.

                        For searching knowing previous names that the organization was known by can be very useful.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        334. Bundle.entry:practice.resource.telecom
                        Definition

                        A contact detail for the organization.

                        ShortA contact detail for the organization
                        Comments

                        The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                        Control1..*
                        This element is affected by the following invariants: org-3
                        TypeContactPoint
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Human contact for the organization.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                        SlicingThis element introduces a set of slices on Bundle.entry.resource.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                        • value @ system
                        • 336. Bundle.entry:practice.resource.telecom.id
                          Definition

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

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          338. Bundle.entry:practice.resource.telecom.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 Bundle.entry.resource.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 340. Bundle.entry:practice.resource.telecom.system
                            Definition

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

                            Shortphone | fax | email | pager | url | sms | other
                            Control0..1
                            This element is affected by the following invariants: cpt-2
                            BindingThe codes SHALL be taken from ContactPointSystem
                            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            342. Bundle.entry:practice.resource.telecom.value
                            Definition

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

                            ShortThe actual contact point details
                            Comments

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

                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            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()))
                            344. Bundle.entry:practice.resource.telecom.use
                            Definition

                            Identifies the purpose for the contact point.

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

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

                            Control0..1
                            BindingThe codes SHALL be taken from ContactPointUse
                            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                            Typecode
                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            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()))
                            346. Bundle.entry:practice.resource.telecom.rank
                            Definition

                            Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                            ShortSpecify preferred order of use (1 = highest)
                            Comments

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

                            Control0..1
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            348. Bundle.entry:practice.resource.telecom.period
                            Definition

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

                            ShortTime period when the contact point was/is in use
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            350. Bundle.entry:practice.resource.telecom:Phone
                            Slice NamePhone
                            Definition

                            A contact detail for the organization.

                            ShortA contact detail for the organization
                            Comments

                            The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                            Control1..*
                            This element is affected by the following invariants: org-3
                            TypeContactPoint
                            Is Modifierfalse
                            Must Supporttrue
                            Summaryfalse
                            Requirements

                            Human contact for the organization.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                            352. Bundle.entry:practice.resource.telecom:Phone.id
                            Definition

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

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            354. Bundle.entry:practice.resource.telecom:Phone.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 Bundle.entry.resource.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 356. Bundle.entry:practice.resource.telecom:Phone.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.3.0)
                              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()))
                              358. Bundle.entry:practice.resource.telecom:Phone.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).

                              ShortPhone (10 digit numeric values only)
                              Comments

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

                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              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()))
                              360. Bundle.entry:practice.resource.telecom:Phone.use
                              Definition

                              Identifies the purpose for the contact point.

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

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

                              Control0..1
                              BindingThe codes SHALL be taken from ContactPointUse
                              (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                              Typecode
                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              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()))
                              362. Bundle.entry:practice.resource.telecom:Phone.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()))
                              364. Bundle.entry:practice.resource.telecom:Phone.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()))
                              366. Bundle.entry:practice.resource.telecom:Fax
                              Slice NameFax
                              Definition

                              A contact detail for the organization.

                              ShortA contact detail for the organization
                              Comments

                              The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                              Control0..*
                              This element is affected by the following invariants: org-3
                              TypeContactPoint
                              Is Modifierfalse
                              Must Supporttrue
                              Summaryfalse
                              Requirements

                              Human contact for the organization.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                              368. Bundle.entry:practice.resource.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
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              370. Bundle.entry:practice.resource.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 Bundle.entry.resource.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 372. Bundle.entry:practice.resource.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.3.0)
                                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()))
                                374. Bundle.entry:practice.resource.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).

                                ShortFax (10 digit numeric values only)
                                Comments

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

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                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()))
                                376. Bundle.entry:practice.resource.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..1
                                BindingThe codes SHALL be taken from ContactPointUse
                                (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                Typecode
                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                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()))
                                378. Bundle.entry:practice.resource.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()))
                                380. Bundle.entry:practice.resource.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()))
                                382. Bundle.entry:practice.resource.address
                                Definition

                                An address for the organization.

                                ShortAddress is required for Practice Organization and Site of Treatment
                                Comments

                                Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

                                Control0..*
                                This element is affected by the following invariants: org-2
                                TypeAddress
                                Is Modifierfalse
                                Must Supporttrue
                                Summaryfalse
                                Requirements

                                May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                                384. Bundle.entry:practice.resource.address.id
                                Definition

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

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                386. Bundle.entry:practice.resource.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 Bundle.entry.resource.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 388. Bundle.entry:practice.resource.address.use
                                  Definition

                                  The purpose of this address.

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

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

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

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

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

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

                                  Example<br/><b>General</b>:home
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  390. Bundle.entry:practice.resource.address.type
                                  Definition

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

                                  Shortpostal | physical | both
                                  Comments

                                  The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

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

                                  The type of an address (physical / postal).

                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Example<br/><b>General</b>:both
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  392. Bundle.entry:practice.resource.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()))
                                  394. Bundle.entry:practice.resource.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.

                                  ShortMax 255 Characters
                                  Control1..3
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  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()))
                                  396. Bundle.entry:practice.resource.address.city
                                  Definition

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

                                  ShortMax 30 Characters
                                  Control1..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  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()))
                                  398. Bundle.entry:practice.resource.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()))
                                  400. Bundle.entry:practice.resource.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).

                                  ShortStandard state 2 characters (Ex: CA, AZ, NC..)
                                  Control1..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Alternate NamesProvince, Territory
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  402. Bundle.entry:practice.resource.address.postalCode
                                  Definition

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

                                  ShortMax 10 Characters
                                  Control1..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  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()))
                                  404. Bundle.entry:practice.resource.address.country
                                  Definition

                                  Country - a nation as commonly understood or generally accepted.

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

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

                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  406. Bundle.entry:practice.resource.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()))
                                  408. Bundle.entry:practice.resource.partOf
                                  Definition

                                  The organization of which this organization forms a part.

                                  ShortThe organization of which this organization forms a part
                                  Control0..1
                                  TypeReference(Organization)
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summarytrue
                                  Requirements

                                  Need to be able to track the hierarchy of organizations within an organization.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  410. Bundle.entry:practice.resource.contact
                                  Definition

                                  Contact for the organization for a certain purpose.

                                  ShortContact is required for Practice Organization
                                  Comments

                                  Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

                                  Control0..*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summaryfalse
                                  Requirements

                                  Need to keep track of assigned contact points within bigger organization.

                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                  412. Bundle.entry:practice.resource.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
                                  414. Bundle.entry:practice.resource.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())
                                  416. Bundle.entry:practice.resource.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())
                                  418. Bundle.entry:practice.resource.contact.purpose
                                  Definition

                                  Indicates a purpose for which the contact can be reached.

                                  ShortThe type of contact
                                  Control0..1
                                  BindingUnless not suitable, these codes SHALL be taken from ContactEntityType
                                  (extensible to http://hl7.org/fhir/ValueSet/contactentity-type)

                                  The purpose for which you would contact a contact party.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Must Supportfalse
                                  Summaryfalse
                                  Requirements

                                  Need to distinguish between multiple contact persons.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  420. Bundle.entry:practice.resource.contact.name
                                  Definition

                                  A name associated with the contact.

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

                                  Need to be able to track the person by name.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  422. Bundle.entry:practice.resource.contact.name.id
                                  Definition

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

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  424. Bundle.entry:practice.resource.contact.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 Bundle.entry.resource.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 426. Bundle.entry:practice.resource.contact.name.use
                                    Definition

                                    Identifies the purpose for this name.

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

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

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

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

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    428. Bundle.entry:practice.resource.contact.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()))
                                    430. Bundle.entry:practice.resource.contact.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.

                                    ShortMax 40 Characters
                                    Comments

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

                                    Control1..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Alternate Namessurname
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    432. Bundle.entry:practice.resource.contact.name.given
                                    Definition

                                    Given name.

                                    ShortMax 80 Characters
                                    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.

                                    Control1..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Alternate Namesfirst name, middle name
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    434. Bundle.entry:practice.resource.contact.name.prefix
                                    Definition

                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                    ShortParts that come before the name
                                    Control0..*
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    436. Bundle.entry:practice.resource.contact.name.suffix
                                    Definition

                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                    ShortParts that come after the name
                                    Control0..*
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    438. Bundle.entry:practice.resource.contact.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()))
                                    440. Bundle.entry:practice.resource.contact.telecom
                                    Definition

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

                                    ShortRequired for Practice Organization
                                    Control1..*
                                    TypeContactPoint
                                    Is Modifierfalse
                                    Must Supporttrue
                                    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()))
                                    SlicingThis element introduces a set of slices on Bundle.entry.resource.contact.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                    • value @ system
                                    • 442. Bundle.entry:practice.resource.contact.telecom.id
                                      Definition

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

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typeid
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      444. Bundle.entry:practice.resource.contact.telecom.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 446. Bundle.entry:practice.resource.contact.telecom.system
                                        Definition

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

                                        Shortphone | fax | email | pager | url | sms | other
                                        Control0..1
                                        This element is affected by the following invariants: cpt-2
                                        BindingThe codes SHALL be taken from ContactPointSystem
                                        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
                                        Typecode
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        448. Bundle.entry:practice.resource.contact.telecom.value
                                        Definition

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

                                        ShortThe actual contact point details
                                        Comments

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

                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        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()))
                                        450. Bundle.entry:practice.resource.contact.telecom.use
                                        Definition

                                        Identifies the purpose for the contact point.

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

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

                                        Control0..1
                                        BindingThe codes SHALL be taken from ContactPointUse
                                        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                        Typecode
                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        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()))
                                        452. Bundle.entry:practice.resource.contact.telecom.rank
                                        Definition

                                        Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                        ShortSpecify preferred order of use (1 = highest)
                                        Comments

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

                                        Control0..1
                                        TypepositiveInt
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        454. Bundle.entry:practice.resource.contact.telecom.period
                                        Definition

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

                                        ShortTime period when the contact point was/is in use
                                        Control0..1
                                        TypePeriod
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        456. Bundle.entry:practice.resource.contact.telecom:Phone
                                        Slice NamePhone
                                        Definition

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

                                        ShortContact details (telephone, email, etc.) for a contact
                                        Control1..*
                                        TypeContactPoint
                                        Is Modifierfalse
                                        Must Supporttrue
                                        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()))
                                        458. Bundle.entry:practice.resource.contact.telecom:Phone.id
                                        Definition

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

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typeid
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        460. Bundle.entry:practice.resource.contact.telecom:Phone.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 462. Bundle.entry:practice.resource.contact.telecom:Phone.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.3.0)
                                          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()))
                                          464. Bundle.entry:practice.resource.contact.telecom:Phone.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).

                                          ShortPhone (10 digit numeric values only)
                                          Comments

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

                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          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()))
                                          466. Bundle.entry:practice.resource.contact.telecom:Phone.use
                                          Definition

                                          Identifies the purpose for the contact point.

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

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

                                          Control0..1
                                          BindingThe codes SHALL be taken from ContactPointUse
                                          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                          Typecode
                                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          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()))
                                          468. Bundle.entry:practice.resource.contact.telecom:Phone.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()))
                                          470. Bundle.entry:practice.resource.contact.telecom:Phone.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()))
                                          472. Bundle.entry:practice.resource.contact.telecom:Fax
                                          Slice NameFax
                                          Definition

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

                                          ShortContact details (telephone, email, etc.) for a contact
                                          Control0..*
                                          TypeContactPoint
                                          Is Modifierfalse
                                          Must Supporttrue
                                          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()))
                                          474. Bundle.entry:practice.resource.contact.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
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          476. Bundle.entry:practice.resource.contact.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 478. Bundle.entry:practice.resource.contact.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.3.0)
                                            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()))
                                            480. Bundle.entry:practice.resource.contact.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).

                                            ShortFax (10 digit numeric values only)
                                            Comments

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

                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            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()))
                                            482. Bundle.entry:practice.resource.contact.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..1
                                            BindingThe codes SHALL be taken from ContactPointUse
                                            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                            Typecode
                                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            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()))
                                            484. Bundle.entry:practice.resource.contact.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()))
                                            486. Bundle.entry:practice.resource.contact.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()))
                                            488. Bundle.entry:practice.resource.contact.telecom:Email
                                            Slice NameEmail
                                            Definition

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

                                            ShortContact details (telephone, email, etc.) for a contact
                                            Control0..*
                                            TypeContactPoint
                                            Is Modifierfalse
                                            Must Supporttrue
                                            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()))
                                            490. Bundle.entry:practice.resource.contact.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
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            492. Bundle.entry:practice.resource.contact.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 494. Bundle.entry:practice.resource.contact.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.3.0)
                                              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()))
                                              496. Bundle.entry:practice.resource.contact.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).

                                              ShortEmail format
                                              Comments

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

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              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()))
                                              498. Bundle.entry:practice.resource.contact.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.3.0)
                                              Typecode
                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              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()))
                                              500. Bundle.entry:practice.resource.contact.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()))
                                              502. Bundle.entry:practice.resource.contact.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()))
                                              504. Bundle.entry:practice.resource.contact.address
                                              Definition

                                              Visiting or postal addresses for the contact.

                                              ShortVisiting or postal addresses for the contact
                                              Control0..1
                                              TypeAddress
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Requirements

                                              May need to keep track of a contact party's address for contacting, billing or reporting requirements.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              506. Bundle.entry:practice.resource.endpoint
                                              Definition

                                              Technical endpoints providing access to services operated for the organization.

                                              ShortTechnical endpoints providing access to services operated for the organization
                                              Control0..*
                                              TypeReference(Endpoint)
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Requirements

                                              Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              508. Bundle.entry:practice.search
                                              Definition

                                              Information about the search process that lead to the creation of this entry.

                                              ShortSearch related information
                                              Control0..0
                                              This element is affected by the following invariants: bdl-2
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              515. Bundle.entry:practice.request
                                              Definition

                                              Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                                              ShortAdditional execution information (transaction/batch/history)
                                              Control0..0
                                              This element is affected by the following invariants: bdl-3
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              526. Bundle.entry:practice.response
                                              Definition

                                              Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                                              ShortResults of execution (transaction/batch/history)
                                              Control0..0
                                              This element is affected by the following invariants: bdl-4
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              536. Bundle.entry:practitioner
                                              Slice Namepractitioner
                                              Definition

                                              An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                                              ShortEntry in the bundle - will have a resource or information
                                              Control1..1
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                                              ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              538. Bundle.entry:practitioner.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
                                              540. Bundle.entry:practitioner.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())
                                              542. Bundle.entry:practitioner.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())
                                              544. Bundle.entry:practitioner.link
                                              Definition

                                              A series of links that provide context to this entry.

                                              ShortLinks related to this entry
                                              Control0..*
                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              546. Bundle.entry:practitioner.fullUrl
                                              Definition

                                              The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                                              • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                                              • Results from operations might involve resources that are not identified.
                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                              Comments

                                              fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                                              Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                                              Control0..1
                                              Typeuri
                                              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()))
                                              548. Bundle.entry:practitioner.resource
                                              Definition

                                              A person who is directly or indirectly involved in the provisioning of healthcare.

                                              ShortA person with a formal responsibility in the provisioning of healthcare or related services
                                              Control1..1
                                              TypePractitioner(UAPI Practitioner)
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summaryfalse
                                              550. Bundle.entry:practitioner.search
                                              Definition

                                              Information about the search process that lead to the creation of this entry.

                                              ShortSearch related information
                                              Control0..0
                                              This element is affected by the following invariants: bdl-2
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              557. Bundle.entry:practitioner.request
                                              Definition

                                              Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                                              ShortAdditional execution information (transaction/batch/history)
                                              Control0..0
                                              This element is affected by the following invariants: bdl-3
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              568. Bundle.entry:practitioner.response
                                              Definition

                                              Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                                              ShortResults of execution (transaction/batch/history)
                                              Control0..0
                                              This element is affected by the following invariants: bdl-4
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              578. Bundle.entry:questionnaireresponse
                                              Slice Namequestionnaireresponse
                                              Definition

                                              An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                                              ShortEntry in the bundle - will have a resource or information
                                              Control1..*
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                                              ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              580. Bundle.entry:questionnaireresponse.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
                                              582. Bundle.entry:questionnaireresponse.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())
                                              584. Bundle.entry:questionnaireresponse.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())
                                              586. Bundle.entry:questionnaireresponse.link
                                              Definition

                                              A series of links that provide context to this entry.

                                              ShortLinks related to this entry
                                              Control0..*
                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              588. Bundle.entry:questionnaireresponse.fullUrl
                                              Definition

                                              The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                                              • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                                              • Results from operations might involve resources that are not identified.
                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                              Comments

                                              fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                                              Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                                              Control0..1
                                              Typeuri
                                              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()))
                                              590. Bundle.entry:questionnaireresponse.resource
                                              Definition

                                              The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

                                              ShortA resource in the bundle
                                              Control1..1
                                              TypeQuestionnaireResponse
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              592. Bundle.entry:questionnaireresponse.search
                                              Definition

                                              Information about the search process that lead to the creation of this entry.

                                              ShortSearch related information
                                              Control0..0
                                              This element is affected by the following invariants: bdl-2
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              599. Bundle.entry:questionnaireresponse.request
                                              Definition

                                              Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                                              ShortAdditional execution information (transaction/batch/history)
                                              Control0..0
                                              This element is affected by the following invariants: bdl-3
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              610. Bundle.entry:questionnaireresponse.response
                                              Definition

                                              Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                                              ShortResults of execution (transaction/batch/history)
                                              Control0..0
                                              This element is affected by the following invariants: bdl-4
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              620. Bundle.entry:medicalCoverage
                                              Slice NamemedicalCoverage
                                              Definition

                                              An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                                              ShortEntry in the bundle - will have a resource or information
                                              Control0..*
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                              bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                                              ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                              622. Bundle.entry:medicalCoverage.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
                                              624. Bundle.entry:medicalCoverage.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())
                                              626. Bundle.entry:medicalCoverage.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())
                                              628. Bundle.entry:medicalCoverage.link
                                              Definition

                                              A series of links that provide context to this entry.

                                              ShortLinks related to this entry
                                              Control0..*
                                              TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              630. Bundle.entry:medicalCoverage.fullUrl
                                              Definition

                                              The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                                              • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                                              • Results from operations might involve resources that are not identified.
                                              ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                              Comments

                                              fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                                              Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                                              Control0..1
                                              Typeuri
                                              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()))
                                              632. Bundle.entry:medicalCoverage.resource
                                              Definition

                                              Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

                                              ShortInsurance or medical plan or a payment agreement
                                              Comments

                                              The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

                                              Control0..1
                                              TypeCoverage(UAPI Coverage)
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summaryfalse
                                              634. Bundle.entry:medicalCoverage.resource.id
                                              Definition

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

                                              ShortLogical id of this artifact
                                              Comments

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

                                              Control0..1
                                              Typeid
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              636. Bundle.entry:medicalCoverage.resource.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()))
                                              638. Bundle.entry:medicalCoverage.resource.implicitRules
                                              Definition

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

                                              ShortA set of rules under which this content was created
                                              Comments

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

                                              Control0..1
                                              Typeuri
                                              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              640. Bundle.entry:medicalCoverage.resource.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)

                                              IETF language tag

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

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

                                              ShortText summary of the resource, for human interpretation
                                              Comments

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

                                              Control0..1
                                              TypeNarrative
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Alternate Namesnarrative, html, xhtml, display
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              644. Bundle.entry:medicalCoverage.resource.contained
                                              Definition

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

                                              ShortContained, inline Resources
                                              Comments

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

                                              Control0..*
                                              TypeResource
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Alternate Namesinline resources, anonymous resources, contained resources
                                              Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                                              646. Bundle.entry:medicalCoverage.resource.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              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())
                                              SlicingThis element introduces a set of slices on Bundle.entry.resource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 648. Bundle.entry:medicalCoverage.resource.extension:PlanYear
                                                Slice NamePlanYear
                                                Definition

                                                Describes Plan year for Coverage Status Outcome

                                                ShortUAPI Coverage Plan Year
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(UAPI Coverage Plan Year) (Extension Type: string)
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                650. Bundle.entry:medicalCoverage.resource.extension:ReferenceNumber
                                                Slice NameReferenceNumber
                                                Definition

                                                Describes Reference Number for Coverage Status Outcome

                                                ShortUAPI Coverage Reference Number
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(UAPI Coverage Reference Number) (Extension Type: string)
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                652. Bundle.entry:medicalCoverage.resource.extension:IssuedDate
                                                Slice NameIssuedDate
                                                Definition

                                                Date when the insurance company issued the insurance card.

                                                ShortUAPI Coverage - Card issuance date
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(UAPI Coverage - Card issuance date) (Extension Type: date)
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                654. Bundle.entry:medicalCoverage.resource.modifierExtension
                                                Definition

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

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

                                                ShortExtensions that cannot be ignored
                                                Comments

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

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

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

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

                                                A unique identifier assigned to this coverage.

                                                ShortBusiness Identifier for the coverage
                                                Comments

                                                The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.

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

                                                Allows coverages to be distinguished and referenced.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                658. Bundle.entry:medicalCoverage.resource.status
                                                Definition

                                                The status of the resource instance.

                                                Shortactive | cancelled | draft | entered-in-error
                                                Comments

                                                This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

                                                Control1..1
                                                BindingThe codes SHALL be taken from FinancialResourceStatusCodes
                                                (required to http://hl7.org/fhir/ValueSet/fm-status|4.3.0)

                                                A code specifying the state of the resource instance.

                                                Typecode
                                                Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                660. Bundle.entry:medicalCoverage.resource.type
                                                Definition

                                                The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

                                                ShortCoverage category such as medical or accident
                                                Control1..1
                                                BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodes
                                                (preferred to http://hl7.org/fhir/ValueSet/coverage-type)

                                                The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

                                                TypeCodeableConcept
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                The order of application of coverages is dependent on the types of coverage.

                                                LabelType of the Coverage
                                                Pattern Value{
                                                  "coding" : [{
                                                    "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                                                    "code" : "HIP"
                                                  }]
                                                }
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                662. Bundle.entry:medicalCoverage.resource.policyHolder
                                                Definition

                                                The party who 'owns' the insurance policy.

                                                ShortOwner of the policy
                                                Comments

                                                For example: may be an individual, corporation or the subscriber's employer.

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

                                                This provides employer information in the case of Worker's Compensation and other policies.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                664. Bundle.entry:medicalCoverage.resource.subscriber
                                                Definition

                                                The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

                                                ShortSubscriber to the policy
                                                Comments

                                                May be self or a parent in the case of dependants.

                                                Control1..1
                                                TypeReference(UAPI Patient, UAPI RelatedPerson)
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                This is the party who is entitled to the benfits under the policy.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                666. Bundle.entry:medicalCoverage.resource.subscriber.id
                                                Definition

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

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typeid
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                668. Bundle.entry:medicalCoverage.resource.subscriber.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 Bundle.entry.resource.subscriber.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 670. Bundle.entry:medicalCoverage.resource.subscriber.reference
                                                  Definition

                                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                  ShortPatient or RelatedPerson resource UUID
                                                  Comments

                                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                  Control0..1
                                                  This element is affected by the following invariants: ref-1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  672. Bundle.entry:medicalCoverage.resource.subscriber.type
                                                  Definition

                                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                  ShortType the reference refers to (e.g. "Patient")
                                                  Comments

                                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                  Control0..1
                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types)
                                                  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()))
                                                  674. Bundle.entry:medicalCoverage.resource.subscriber.identifier
                                                  Definition

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

                                                  ShortLogical reference, when literal reference is not known
                                                  Comments

                                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

                                                  ShortText alternative for the resource
                                                  Comments

                                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  678. Bundle.entry:medicalCoverage.resource.subscriberId
                                                  Definition

                                                  The insurer assigned ID for the Subscriber.

                                                  ShortID assigned to the subscriber
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Requirements

                                                  The insurer requires this identifier on correspondance and claims (digital and otherwise).

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  680. Bundle.entry:medicalCoverage.resource.beneficiary
                                                  Definition

                                                  The party who benefits from the insurance coverage; the patient when products and/or services are provided.

                                                  ShortPlan beneficiary
                                                  Control1..1
                                                  TypeReference(UAPI Patient)
                                                  Is Modifierfalse
                                                  Must Supportfalse
                                                  Summarytrue
                                                  Requirements

                                                  This is the party who receives treatment for which the costs are reimbursed under the coverage.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  682. Bundle.entry:medicalCoverage.resource.beneficiary.id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  Typeid
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  684. Bundle.entry:medicalCoverage.resource.beneficiary.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 Bundle.entry.resource.beneficiary.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 686. Bundle.entry:medicalCoverage.resource.beneficiary.reference
                                                    Definition

                                                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                    ShortPatient resource UUID
                                                    Comments

                                                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                    Control0..1
                                                    This element is affected by the following invariants: ref-1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    688. Bundle.entry:medicalCoverage.resource.beneficiary.type
                                                    Definition

                                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                    ShortType the reference refers to (e.g. "Patient")
                                                    Comments

                                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                    Control0..1
                                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types)
                                                    Typeuri
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Pattern ValuePatient
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    690. Bundle.entry:medicalCoverage.resource.beneficiary.identifier
                                                    Definition

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

                                                    ShortLogical reference, when literal reference is not known
                                                    Comments

                                                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

                                                    ShortText alternative for the resource
                                                    Comments

                                                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    694. Bundle.entry:medicalCoverage.resource.dependent
                                                    Definition

                                                    A unique identifier for a dependent under the coverage.

                                                    ShortDependent number
                                                    Comments

                                                    Periodically the member number is constructed from the subscriberId and the dependant number.

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

                                                    For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    696. Bundle.entry:medicalCoverage.resource.relationship
                                                    Definition

                                                    The relationship of beneficiary (patient) to the subscriber.

                                                    ShortBeneficiary relationship to the subscriber
                                                    Comments

                                                    Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

                                                    Control0..1
                                                    BindingUnless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes
                                                    (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship)

                                                    The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summaryfalse
                                                    Requirements

                                                    To determine relationship between the patient and the subscriber to determine coordination of benefits.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    698. Bundle.entry:medicalCoverage.resource.period
                                                    Definition

                                                    Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

                                                    ShortCoverage start and end dates
                                                    Control0..1
                                                    TypePeriod
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Requirements

                                                    Some insurers require the submission of the coverage term.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    700. Bundle.entry:medicalCoverage.resource.payor
                                                    Definition

                                                    The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

                                                    ShortIssuer of the policy
                                                    Comments

                                                    May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

                                                    Control1..*
                                                    TypeReference(UAPI Organization)
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Requirements

                                                    Need to identify the issuer to target for claim processing and for coordination of benefit processing.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    702. Bundle.entry:medicalCoverage.resource.payor.id
                                                    Definition

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

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    Typeid
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    704. Bundle.entry:medicalCoverage.resource.payor.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 Bundle.entry.resource.payor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 706. Bundle.entry:medicalCoverage.resource.payor.reference
                                                      Definition

                                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                      ShortPayor Orginization resource UUID
                                                      Comments

                                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                      Control0..1
                                                      This element is affected by the following invariants: ref-1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      708. Bundle.entry:medicalCoverage.resource.payor.type
                                                      Definition

                                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                      ShortType the reference refers to (e.g. "Patient")
                                                      Comments

                                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                      Control0..1
                                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types)
                                                      Typeuri
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Pattern ValueOrganization
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      710. Bundle.entry:medicalCoverage.resource.payor.identifier
                                                      Definition

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

                                                      ShortLogical reference, when literal reference is not known
                                                      Comments

                                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

                                                      ShortText alternative for the resource
                                                      Comments

                                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      714. Bundle.entry:medicalCoverage.resource.class
                                                      Definition

                                                      A suite of underwriter specific classifiers.

                                                      ShortAdditional coverage classifications
                                                      Comments

                                                      For example may be used to identify a class of coverage or employer group, Policy, Plan.

                                                      Control1..*
                                                      TypeBackboneElement
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summaryfalse
                                                      Requirements

                                                      The codes provided on the health card which identify or confirm the specific policy for the insurer.

                                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                      716. Bundle.entry:medicalCoverage.resource.class.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
                                                      718. Bundle.entry:medicalCoverage.resource.class.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())
                                                      720. Bundle.entry:medicalCoverage.resource.class.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())
                                                      722. Bundle.entry:medicalCoverage.resource.class.type
                                                      Definition

                                                      The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

                                                      ShortType of class such as 'group' or 'plan'
                                                      Control1..1
                                                      BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodes
                                                      (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

                                                      The policy classifications, eg. Group, Plan, Class, etc.

                                                      TypeCodeableConcept
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summarytrue
                                                      Requirements

                                                      The insurer issued label for a specific health card value.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      724. Bundle.entry:medicalCoverage.resource.class.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
                                                      Typeid
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      726. Bundle.entry:medicalCoverage.resource.class.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 Bundle.entry.resource.class.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 728. Bundle.entry:medicalCoverage.resource.class.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
                                                        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()))
                                                        730. Bundle.entry:medicalCoverage.resource.class.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
                                                        Typeid
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        732. Bundle.entry:medicalCoverage.resource.class.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 Bundle.entry.resource.class.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 734. Bundle.entry:medicalCoverage.resource.class.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
                                                          Summarytrue
                                                          Requirements

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

                                                          Pattern Valuehttp://terminology.hl7.org/CodeSystem/coverage-class
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          736. Bundle.entry:medicalCoverage.resource.class.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()))
                                                          738. Bundle.entry:medicalCoverage.resource.class.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
                                                          Summarytrue
                                                          Requirements

                                                          Need to refer to a particular code in the system.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          740. Bundle.entry:medicalCoverage.resource.class.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()))
                                                          742. Bundle.entry:medicalCoverage.resource.class.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()))
                                                          744. Bundle.entry:medicalCoverage.resource.class.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()))
                                                          746. Bundle.entry:medicalCoverage.resource.class.value
                                                          Definition

                                                          The alphanumeric string value associated with the insurer issued label.

                                                          ShortValue associated with the type
                                                          Comments

                                                          For example, the Group or Plan number.

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

                                                          The insurer issued label and value are necessary to identify the specific policy.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          748. Bundle.entry:medicalCoverage.resource.class.name
                                                          Definition

                                                          A short description for the class.

                                                          ShortHuman readable description of the type and value
                                                          Control1..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

                                                          Used to provide a meaningful description in correspondence to the patient.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          750. Bundle.entry:medicalCoverage.resource.order
                                                          Definition

                                                          The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

                                                          ShortRelative order of the coverage
                                                          Control1..1
                                                          TypepositiveInt
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Requirements

                                                          Used in managing the coordination of benefits.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          752. Bundle.entry:medicalCoverage.resource.network
                                                          Definition

                                                          The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

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

                                                          Used in referral for treatment and in claims processing.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          754. Bundle.entry:medicalCoverage.resource.costToBeneficiary
                                                          Definition

                                                          A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

                                                          ShortPatient payments for services/products
                                                          Comments

                                                          For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.

                                                          Control0..*
                                                          TypeBackboneElement
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Requirements

                                                          Required by providers to manage financial transaction with the patient.

                                                          Alternate NamesCoPay, Deductible, Exceptions
                                                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                          756. Bundle.entry:medicalCoverage.resource.costToBeneficiary.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
                                                          758. Bundle.entry:medicalCoverage.resource.costToBeneficiary.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())
                                                          760. Bundle.entry:medicalCoverage.resource.costToBeneficiary.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())
                                                          762. Bundle.entry:medicalCoverage.resource.costToBeneficiary.type
                                                          Definition

                                                          The category of patient centric costs associated with treatment.

                                                          ShortCost category
                                                          Comments

                                                          For example visit, specialist visits, emergency, inpatient care, etc.

                                                          Control0..1
                                                          BindingUnless not suitable, these codes SHALL be taken from CoverageCopayTypeCodes
                                                          (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type)

                                                          The types of services to which patient copayments are specified.

                                                          TypeCodeableConcept
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

                                                          Needed to identify the category associated with the amount for the patient.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          764. Bundle.entry:medicalCoverage.resource.costToBeneficiary.value[x]
                                                          Definition

                                                          The amount due from the patient for the cost category.

                                                          ShortThe amount or percentage due from the beneficiary
                                                          Comments

                                                          Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.

                                                          Control1..1
                                                          TypeChoice of: Quantity(SimpleQuantity), Money
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

                                                          Needed to identify the amount for the patient associated with the category.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          766. Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception
                                                          Definition

                                                          A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

                                                          ShortExceptions for patient payments
                                                          Control0..*
                                                          TypeBackboneElement
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Requirements

                                                          Required by providers to manage financial transaction with the patient.

                                                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                          768. Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.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
                                                          770. Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.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())
                                                          772. Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.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())
                                                          774. Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.type
                                                          Definition

                                                          The code for the specific exception.

                                                          ShortException category
                                                          Control1..1
                                                          BindingFor example codes, see ExampleCoverageFinancialExceptionCodes
                                                          (example to http://hl7.org/fhir/ValueSet/coverage-financial-exception)

                                                          The types of exceptions from the part or full value of financial obligations such as copays.

                                                          TypeCodeableConcept
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

                                                          Needed to identify the exception associated with the amount for the patient.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          776. Bundle.entry:medicalCoverage.resource.costToBeneficiary.exception.period
                                                          Definition

                                                          The timeframe during when the exception is in force.

                                                          ShortThe effective period of the exception
                                                          Control0..1
                                                          TypePeriod
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

                                                          Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          778. Bundle.entry:medicalCoverage.resource.subrogation
                                                          Definition

                                                          When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

                                                          ShortReimbursement to insurer
                                                          Comments

                                                          Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.

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

                                                          See definition for when to be used.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          780. Bundle.entry:medicalCoverage.resource.contract
                                                          Definition

                                                          The policy(s) which constitute this insurance coverage.

                                                          ShortContract details
                                                          Control0..*
                                                          TypeReference(Contract)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Requirements

                                                          To reference the legally binding contract between the policy holder and the insurer.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          782. Bundle.entry:medicalCoverage.search
                                                          Definition

                                                          Information about the search process that lead to the creation of this entry.

                                                          ShortSearch related information
                                                          Control0..0
                                                          This element is affected by the following invariants: bdl-2
                                                          TypeBackboneElement
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                          789. Bundle.entry:medicalCoverage.request
                                                          Definition

                                                          Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                                                          ShortAdditional execution information (transaction/batch/history)
                                                          Control0..0
                                                          This element is affected by the following invariants: bdl-3
                                                          TypeBackboneElement
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                          800. Bundle.entry:medicalCoverage.response
                                                          Definition

                                                          Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                                                          ShortResults of execution (transaction/batch/history)
                                                          Control0..0
                                                          This element is affected by the following invariants: bdl-4
                                                          TypeBackboneElement
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                          810. Bundle.entry:pharmacyCoverage
                                                          Slice NamepharmacyCoverage
                                                          Definition

                                                          An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                                                          ShortEntry in the bundle - will have a resource or information
                                                          Control0..*
                                                          TypeBackboneElement
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                          bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                                                          ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                          812. Bundle.entry:pharmacyCoverage.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
                                                          814. Bundle.entry:pharmacyCoverage.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())
                                                          816. Bundle.entry:pharmacyCoverage.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())
                                                          818. Bundle.entry:pharmacyCoverage.link
                                                          Definition

                                                          A series of links that provide context to this entry.

                                                          ShortLinks related to this entry
                                                          Control0..*
                                                          TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          820. Bundle.entry:pharmacyCoverage.fullUrl
                                                          Definition

                                                          The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                                                          • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                                                          • Results from operations might involve resources that are not identified.
                                                          ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                          Comments

                                                          fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                                                          Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                                                          Control0..1
                                                          Typeuri
                                                          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()))
                                                          822. Bundle.entry:pharmacyCoverage.resource
                                                          Definition

                                                          Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

                                                          ShortInsurance or medical plan or a payment agreement
                                                          Comments

                                                          The Coverage resource contains the insurance card level information, which is customary to provide on claims and other communications between providers and insurers.

                                                          Control0..1
                                                          TypeCoverage(UAPI Coverage)
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          Summaryfalse
                                                          824. Bundle.entry:pharmacyCoverage.resource.id
                                                          Definition

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

                                                          ShortLogical id of this artifact
                                                          Comments

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

                                                          Control0..1
                                                          Typeid
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          826. Bundle.entry:pharmacyCoverage.resource.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()))
                                                          828. Bundle.entry:pharmacyCoverage.resource.implicitRules
                                                          Definition

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

                                                          ShortA set of rules under which this content was created
                                                          Comments

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

                                                          Control0..1
                                                          Typeuri
                                                          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          830. Bundle.entry:pharmacyCoverage.resource.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)

                                                          IETF language tag

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

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

                                                          ShortText summary of the resource, for human interpretation
                                                          Comments

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

                                                          Control0..1
                                                          TypeNarrative
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Alternate Namesnarrative, html, xhtml, display
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          834. Bundle.entry:pharmacyCoverage.resource.contained
                                                          Definition

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

                                                          ShortContained, inline Resources
                                                          Comments

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

                                                          Control0..*
                                                          TypeResource
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summaryfalse
                                                          Alternate Namesinline resources, anonymous resources, contained resources
                                                          Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                                                          836. Bundle.entry:pharmacyCoverage.resource.extension
                                                          Definition

                                                          An Extension

                                                          ShortExtension
                                                          Control0..*
                                                          TypeExtension
                                                          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())
                                                          SlicingThis element introduces a set of slices on Bundle.entry.resource.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 838. Bundle.entry:pharmacyCoverage.resource.extension:PlanYear
                                                            Slice NamePlanYear
                                                            Definition

                                                            Describes Plan year for Coverage Status Outcome

                                                            ShortUAPI Coverage Plan Year
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(UAPI Coverage Plan Year) (Extension Type: string)
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            840. Bundle.entry:pharmacyCoverage.resource.extension:ReferenceNumber
                                                            Slice NameReferenceNumber
                                                            Definition

                                                            Describes Reference Number for Coverage Status Outcome

                                                            ShortUAPI Coverage Reference Number
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(UAPI Coverage Reference Number) (Extension Type: string)
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            842. Bundle.entry:pharmacyCoverage.resource.extension:IssuedDate
                                                            Slice NameIssuedDate
                                                            Definition

                                                            Date when the insurance company issued the insurance card.

                                                            ShortUAPI Coverage - Card issuance date
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(UAPI Coverage - Card issuance date) (Extension Type: date)
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            844. Bundle.entry:pharmacyCoverage.resource.modifierExtension
                                                            Definition

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

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

                                                            ShortExtensions that cannot be ignored
                                                            Comments

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

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

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

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

                                                            A unique identifier assigned to this coverage.

                                                            ShortBusiness Identifier for the coverage
                                                            Comments

                                                            The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatenation of the Coverage.SubscriberID and the Coverage.dependant.

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

                                                            Allows coverages to be distinguished and referenced.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            848. Bundle.entry:pharmacyCoverage.resource.status
                                                            Definition

                                                            The status of the resource instance.

                                                            Shortactive | cancelled | draft | entered-in-error
                                                            Comments

                                                            This element is labeled as a modifier because the status contains the code entered-in-error that marks the coverage as not currently valid.

                                                            Control1..1
                                                            BindingThe codes SHALL be taken from FinancialResourceStatusCodes
                                                            (required to http://hl7.org/fhir/ValueSet/fm-status|4.3.0)

                                                            A code specifying the state of the resource instance.

                                                            Typecode
                                                            Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supportfalse
                                                            Summarytrue
                                                            Requirements

                                                            Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            850. Bundle.entry:pharmacyCoverage.resource.type
                                                            Definition

                                                            The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.

                                                            ShortCoverage category such as medical or accident
                                                            Control1..1
                                                            BindingThe codes SHOULD be taken from CoverageTypeAndSelf-PayCodes
                                                            (preferred to http://hl7.org/fhir/ValueSet/coverage-type)

                                                            The type of insurance: public health, worker compensation; private accident, auto, private health, etc.) or a direct payment by an individual or organization.

                                                            TypeCodeableConcept
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Summarytrue
                                                            Requirements

                                                            The order of application of coverages is dependent on the types of coverage.

                                                            LabelType of the Coverage
                                                            Pattern Value{
                                                              "coding" : [{
                                                                "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                                                                "code" : "DRUGPOL"
                                                              }]
                                                            }
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            852. Bundle.entry:pharmacyCoverage.resource.policyHolder
                                                            Definition

                                                            The party who 'owns' the insurance policy.

                                                            ShortOwner of the policy
                                                            Comments

                                                            For example: may be an individual, corporation or the subscriber's employer.

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

                                                            This provides employer information in the case of Worker's Compensation and other policies.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            854. Bundle.entry:pharmacyCoverage.resource.subscriber
                                                            Definition

                                                            The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.

                                                            ShortSubscriber to the policy
                                                            Comments

                                                            May be self or a parent in the case of dependants.

                                                            Control1..1
                                                            TypeReference(UAPI Patient, UAPI RelatedPerson)
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summarytrue
                                                            Requirements

                                                            This is the party who is entitled to the benfits under the policy.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            856. Bundle.entry:pharmacyCoverage.resource.subscriber.id
                                                            Definition

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

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            Typeid
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            858. Bundle.entry:pharmacyCoverage.resource.subscriber.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 Bundle.entry.resource.subscriber.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 860. Bundle.entry:pharmacyCoverage.resource.subscriber.reference
                                                              Definition

                                                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                              ShortPatient or RelatedPerson resource UUID
                                                              Comments

                                                              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                              Control0..1
                                                              This element is affected by the following invariants: ref-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              862. Bundle.entry:pharmacyCoverage.resource.subscriber.type
                                                              Definition

                                                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                              ShortType the reference refers to (e.g. "Patient")
                                                              Comments

                                                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                              Control0..1
                                                              BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                              (extensible to http://hl7.org/fhir/ValueSet/resource-types)
                                                              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()))
                                                              864. Bundle.entry:pharmacyCoverage.resource.subscriber.identifier
                                                              Definition

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

                                                              ShortLogical reference, when literal reference is not known
                                                              Comments

                                                              When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                              When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                              Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

                                                              ShortText alternative for the resource
                                                              Comments

                                                              This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              868. Bundle.entry:pharmacyCoverage.resource.subscriberId
                                                              Definition

                                                              The insurer assigned ID for the Subscriber.

                                                              ShortID assigned to the subscriber
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supporttrue
                                                              Summarytrue
                                                              Requirements

                                                              The insurer requires this identifier on correspondance and claims (digital and otherwise).

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              870. Bundle.entry:pharmacyCoverage.resource.beneficiary
                                                              Definition

                                                              The party who benefits from the insurance coverage; the patient when products and/or services are provided.

                                                              ShortPlan beneficiary
                                                              Control1..1
                                                              TypeReference(UAPI Patient)
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summarytrue
                                                              Requirements

                                                              This is the party who receives treatment for which the costs are reimbursed under the coverage.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              872. Bundle.entry:pharmacyCoverage.resource.beneficiary.id
                                                              Definition

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              Typeid
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              874. Bundle.entry:pharmacyCoverage.resource.beneficiary.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 Bundle.entry.resource.beneficiary.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 876. Bundle.entry:pharmacyCoverage.resource.beneficiary.reference
                                                                Definition

                                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                ShortPatient resource UUID
                                                                Comments

                                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                Control0..1
                                                                This element is affected by the following invariants: ref-1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                878. Bundle.entry:pharmacyCoverage.resource.beneficiary.type
                                                                Definition

                                                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                ShortType the reference refers to (e.g. "Patient")
                                                                Comments

                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                Control0..1
                                                                BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types)
                                                                Typeuri
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Pattern ValuePatient
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                880. Bundle.entry:pharmacyCoverage.resource.beneficiary.identifier
                                                                Definition

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

                                                                ShortLogical reference, when literal reference is not known
                                                                Comments

                                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

                                                                ShortText alternative for the resource
                                                                Comments

                                                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                884. Bundle.entry:pharmacyCoverage.resource.dependent
                                                                Definition

                                                                A unique identifier for a dependent under the coverage.

                                                                ShortDependent number
                                                                Comments

                                                                Periodically the member number is constructed from the subscriberId and the dependant number.

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

                                                                For some coverages a single identifier is issued to the Subscriber and then a unique dependent number is issued to each beneficiary.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                886. Bundle.entry:pharmacyCoverage.resource.relationship
                                                                Definition

                                                                The relationship of beneficiary (patient) to the subscriber.

                                                                ShortBeneficiary relationship to the subscriber
                                                                Comments

                                                                Typically, an individual uses policies which are theirs (relationship='self') before policies owned by others.

                                                                Control0..1
                                                                BindingUnless not suitable, these codes SHALL be taken from SubscriberRelationshipCodes
                                                                (extensible to http://hl7.org/fhir/ValueSet/subscriber-relationship)

                                                                The relationship between the Subscriber and the Beneficiary (insured/covered party/patient).

                                                                TypeCodeableConcept
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summaryfalse
                                                                Requirements

                                                                To determine relationship between the patient and the subscriber to determine coordination of benefits.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                888. Bundle.entry:pharmacyCoverage.resource.period
                                                                Definition

                                                                Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.

                                                                ShortCoverage start and end dates
                                                                Control0..1
                                                                TypePeriod
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Requirements

                                                                Some insurers require the submission of the coverage term.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                890. Bundle.entry:pharmacyCoverage.resource.payor
                                                                Definition

                                                                The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.

                                                                ShortIssuer of the policy
                                                                Comments

                                                                May provide multiple identifiers such as insurance company identifier or business identifier (BIN number). For selfpay it may provide multiple paying persons and/or organizations.

                                                                Control1..*
                                                                TypeReference(UAPI Organization)
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Requirements

                                                                Need to identify the issuer to target for claim processing and for coordination of benefit processing.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                892. Bundle.entry:pharmacyCoverage.resource.payor.id
                                                                Definition

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                Typeid
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                894. Bundle.entry:pharmacyCoverage.resource.payor.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 Bundle.entry.resource.payor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 896. Bundle.entry:pharmacyCoverage.resource.payor.reference
                                                                  Definition

                                                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                                  ShortPayor Orginization resource UUID
                                                                  Comments

                                                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                                  Control0..1
                                                                  This element is affected by the following invariants: ref-1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  898. Bundle.entry:pharmacyCoverage.resource.payor.type
                                                                  Definition

                                                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                  ShortType the reference refers to (e.g. "Patient")
                                                                  Comments

                                                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                  Control0..1
                                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types)
                                                                  Typeuri
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Pattern ValueOrganization
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  900. Bundle.entry:pharmacyCoverage.resource.payor.identifier
                                                                  Definition

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

                                                                  ShortLogical reference, when literal reference is not known
                                                                  Comments

                                                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

                                                                  ShortText alternative for the resource
                                                                  Comments

                                                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  904. Bundle.entry:pharmacyCoverage.resource.class
                                                                  Definition

                                                                  A suite of underwriter specific classifiers.

                                                                  ShortAdditional coverage classifications
                                                                  Comments

                                                                  For example may be used to identify a class of coverage or employer group, Policy, Plan.

                                                                  Control1..*
                                                                  TypeBackboneElement
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summaryfalse
                                                                  Requirements

                                                                  The codes provided on the health card which identify or confirm the specific policy for the insurer.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                  906. Bundle.entry:pharmacyCoverage.resource.class.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
                                                                  908. Bundle.entry:pharmacyCoverage.resource.class.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())
                                                                  910. Bundle.entry:pharmacyCoverage.resource.class.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())
                                                                  912. Bundle.entry:pharmacyCoverage.resource.class.type
                                                                  Definition

                                                                  The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan.

                                                                  ShortType of class such as 'group' or 'plan'
                                                                  Control1..1
                                                                  BindingUnless not suitable, these codes SHALL be taken from CoverageClassCodes
                                                                  (extensible to http://hl7.org/fhir/ValueSet/coverage-class)

                                                                  The policy classifications, eg. Group, Plan, Class, etc.

                                                                  TypeCodeableConcept
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summarytrue
                                                                  Requirements

                                                                  The insurer issued label for a specific health card value.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  914. Bundle.entry:pharmacyCoverage.resource.class.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
                                                                  Typeid
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  916. Bundle.entry:pharmacyCoverage.resource.class.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 Bundle.entry.resource.class.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 918. Bundle.entry:pharmacyCoverage.resource.class.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
                                                                    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()))
                                                                    920. Bundle.entry:pharmacyCoverage.resource.class.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
                                                                    Typeid
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    922. Bundle.entry:pharmacyCoverage.resource.class.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 Bundle.entry.resource.class.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 924. Bundle.entry:pharmacyCoverage.resource.class.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
                                                                      Summarytrue
                                                                      Requirements

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

                                                                      Pattern Valuehttp://terminology.hl7.org/CodeSystem/coverage-class
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      926. Bundle.entry:pharmacyCoverage.resource.class.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()))
                                                                      928. Bundle.entry:pharmacyCoverage.resource.class.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
                                                                      Summarytrue
                                                                      Requirements

                                                                      Need to refer to a particular code in the system.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      930. Bundle.entry:pharmacyCoverage.resource.class.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()))
                                                                      932. Bundle.entry:pharmacyCoverage.resource.class.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()))
                                                                      934. Bundle.entry:pharmacyCoverage.resource.class.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()))
                                                                      936. Bundle.entry:pharmacyCoverage.resource.class.value
                                                                      Definition

                                                                      The alphanumeric string value associated with the insurer issued label.

                                                                      ShortValue associated with the type
                                                                      Comments

                                                                      For example, the Group or Plan number.

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

                                                                      The insurer issued label and value are necessary to identify the specific policy.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      938. Bundle.entry:pharmacyCoverage.resource.class.name
                                                                      Definition

                                                                      A short description for the class.

                                                                      ShortHuman readable description of the type and value
                                                                      Control1..1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      Used to provide a meaningful description in correspondence to the patient.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      940. Bundle.entry:pharmacyCoverage.resource.order
                                                                      Definition

                                                                      The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.

                                                                      ShortRelative order of the coverage
                                                                      Control1..1
                                                                      TypepositiveInt
                                                                      Is Modifierfalse
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Requirements

                                                                      Used in managing the coordination of benefits.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      942. Bundle.entry:pharmacyCoverage.resource.network
                                                                      Definition

                                                                      The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.

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

                                                                      Used in referral for treatment and in claims processing.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      944. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary
                                                                      Definition

                                                                      A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

                                                                      ShortPatient payments for services/products
                                                                      Comments

                                                                      For example by knowing the patient visit co-pay, the provider can collect the amount prior to undertaking treatment.

                                                                      Control0..*
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Required by providers to manage financial transaction with the patient.

                                                                      Alternate NamesCoPay, Deductible, Exceptions
                                                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                      946. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.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
                                                                      948. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.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())
                                                                      950. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.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())
                                                                      952. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.type
                                                                      Definition

                                                                      The category of patient centric costs associated with treatment.

                                                                      ShortCost category
                                                                      Comments

                                                                      For example visit, specialist visits, emergency, inpatient care, etc.

                                                                      Control0..1
                                                                      BindingUnless not suitable, these codes SHALL be taken from CoverageCopayTypeCodes
                                                                      (extensible to http://hl7.org/fhir/ValueSet/coverage-copay-type)

                                                                      The types of services to which patient copayments are specified.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      Needed to identify the category associated with the amount for the patient.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      954. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.value[x]
                                                                      Definition

                                                                      The amount due from the patient for the cost category.

                                                                      ShortThe amount or percentage due from the beneficiary
                                                                      Comments

                                                                      Amount may be expressed as a percentage of the service/product cost or a fixed amount of currency.

                                                                      Control1..1
                                                                      TypeChoice of: Quantity(SimpleQuantity), Money
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      Needed to identify the amount for the patient associated with the category.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      956. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception
                                                                      Definition

                                                                      A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

                                                                      ShortExceptions for patient payments
                                                                      Control0..*
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Required by providers to manage financial transaction with the patient.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                      958. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.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
                                                                      960. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.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())
                                                                      962. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.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())
                                                                      964. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.type
                                                                      Definition

                                                                      The code for the specific exception.

                                                                      ShortException category
                                                                      Control1..1
                                                                      BindingFor example codes, see ExampleCoverageFinancialExceptionCodes
                                                                      (example to http://hl7.org/fhir/ValueSet/coverage-financial-exception)

                                                                      The types of exceptions from the part or full value of financial obligations such as copays.

                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      Needed to identify the exception associated with the amount for the patient.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      966. Bundle.entry:pharmacyCoverage.resource.costToBeneficiary.exception.period
                                                                      Definition

                                                                      The timeframe during when the exception is in force.

                                                                      ShortThe effective period of the exception
                                                                      Control0..1
                                                                      TypePeriod
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      Needed to identify the applicable timeframe for the exception for the correct calculation of patient costs.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      968. Bundle.entry:pharmacyCoverage.resource.subrogation
                                                                      Definition

                                                                      When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.

                                                                      ShortReimbursement to insurer
                                                                      Comments

                                                                      Typically, automotive and worker's compensation policies would be flagged with 'subrogation=true' to enable healthcare payors to collect against accident claims.

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

                                                                      See definition for when to be used.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      970. Bundle.entry:pharmacyCoverage.resource.contract
                                                                      Definition

                                                                      The policy(s) which constitute this insurance coverage.

                                                                      ShortContract details
                                                                      Control0..*
                                                                      TypeReference(Contract)
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      To reference the legally binding contract between the policy holder and the insurer.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      972. Bundle.entry:pharmacyCoverage.search
                                                                      Definition

                                                                      Information about the search process that lead to the creation of this entry.

                                                                      ShortSearch related information
                                                                      Control0..0
                                                                      This element is affected by the following invariants: bdl-2
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                      979. Bundle.entry:pharmacyCoverage.request
                                                                      Definition

                                                                      Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                                                                      ShortAdditional execution information (transaction/batch/history)
                                                                      Control0..0
                                                                      This element is affected by the following invariants: bdl-3
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                      990. Bundle.entry:pharmacyCoverage.response
                                                                      Definition

                                                                      Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                                                                      ShortResults of execution (transaction/batch/history)
                                                                      Control0..0
                                                                      This element is affected by the following invariants: bdl-4
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                      1000. Bundle.entry:payer
                                                                      Slice Namepayer
                                                                      Definition

                                                                      An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

                                                                      ShortEntry in the bundle - will have a resource or information
                                                                      Control0..*
                                                                      TypeBackboneElement
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Invariantsbdl-5: must be a resource unless there's a request or response (resource.exists() or request.exists() or response.exists())
                                                                      bdl-8: fullUrl cannot be a version specific reference (fullUrl.exists() implies fullUrl.contains('/_history/').not())
                                                                      ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                      1002. Bundle.entry:payer.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
                                                                      1004. Bundle.entry:payer.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())
                                                                      1006. Bundle.entry:payer.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())
                                                                      1008. Bundle.entry:payer.link
                                                                      Definition

                                                                      A series of links that provide context to this entry.

                                                                      ShortLinks related to this entry
                                                                      Control0..*
                                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      1010. Bundle.entry:payer.fullUrl
                                                                      Definition

                                                                      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

                                                                      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
                                                                      • Results from operations might involve resources that are not identified.
                                                                      ShortURI for resource (Absolute URL server address or URI for UUID/OID)
                                                                      Comments

                                                                      fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

                                                                      Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

                                                                      Control0..1
                                                                      Typeuri
                                                                      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()))
                                                                      1012. Bundle.entry:payer.resource
                                                                      Definition

                                                                      A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                                                                      ShortA grouping of people or organizations with a common purpose
                                                                      Control0..1
                                                                      TypeOrganization(UAPI Organization)
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Summaryfalse
                                                                      1014. Bundle.entry:payer.resource.id
                                                                      Definition

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

                                                                      ShortLogical id of this artifact
                                                                      Comments

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

                                                                      Control0..1
                                                                      Typeid
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      1016. Bundle.entry:payer.resource.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()))
                                                                      1018. Bundle.entry:payer.resource.implicitRules
                                                                      Definition

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

                                                                      ShortA set of rules under which this content was created
                                                                      Comments

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

                                                                      Control0..1
                                                                      Typeuri
                                                                      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      1020. Bundle.entry:payer.resource.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)

                                                                      IETF language tag

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

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

                                                                      ShortText summary of the resource, for human interpretation
                                                                      Comments

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

                                                                      Control0..1
                                                                      TypeNarrative
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Alternate Namesnarrative, html, xhtml, display
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      1024. Bundle.entry:payer.resource.contained
                                                                      Definition

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

                                                                      ShortContained, inline Resources
                                                                      Comments

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

                                                                      Control0..*
                                                                      TypeResource
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Alternate Namesinline resources, anonymous resources, contained resources
                                                                      Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                                                                      1026. Bundle.entry:payer.resource.extension
                                                                      Definition

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

                                                                      ShortAdditional content defined by implementations
                                                                      Comments

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

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      1028. Bundle.entry:payer.resource.modifierExtension
                                                                      Definition

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

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

                                                                      ShortExtensions that cannot be ignored
                                                                      Comments

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

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

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

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

                                                                      Identifier for the organization that is used to identify the organization across multiple disparate systems.

                                                                      ShortIdentifier used by Genentech to determine insert vs update operation.
                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                      Control1..*
                                                                      This element is affected by the following invariants: org-1
                                                                      TypeIdentifier
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Summarytrue
                                                                      Requirements

                                                                      Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      1032. Bundle.entry:payer.resource.identifier.id
                                                                      Definition

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

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      Typeid
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      1034. Bundle.entry:payer.resource.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 Bundle.entry.resource.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 1036. Bundle.entry:payer.resource.identifier.use
                                                                        Definition

                                                                        The purpose of this identifier.

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

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

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

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

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        1038. Bundle.entry:payer.resource.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)
                                                                        TypeCodeableConcept
                                                                        Is Modifierfalse
                                                                        Summarytrue
                                                                        Requirements

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

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        1040. Bundle.entry:payer.resource.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
                                                                        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()))
                                                                        1042. Bundle.entry:payer.resource.identifier.value
                                                                        Definition

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

                                                                        ShortUnique identifier for the organization
                                                                        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
                                                                        Summarytrue
                                                                        Example<br/><b>General</b>:123456
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        1044. Bundle.entry:payer.resource.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()))
                                                                        1046. Bundle.entry:payer.resource.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()))
                                                                        1048. Bundle.entry:payer.resource.active
                                                                        Definition

                                                                        Whether the organization's record is still in active use.

                                                                        ShortWhether the organization's record is still in active use
                                                                        Comments

                                                                        This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

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

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

                                                                        Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

                                                                        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()))
                                                                        1050. Bundle.entry:payer.resource.type
                                                                        Definition

                                                                        Only three types of organizations are supported - Provider organization, Insurance organization and Site of Treatment.

                                                                        ShortOrganization type for enrollment
                                                                        Comments

                                                                        Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

                                                                        When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

                                                                        We expect that some jurisdictions will profile this optionality to be a single cardinality.

                                                                        Control1..1
                                                                        BindingThe codes SHALL be taken from UAPI Value Set - Organization Type
                                                                        (required to https://fhir.developer.gene.com/ValueSet/uapi-org-type)

                                                                        Organization Type Codes

                                                                        TypeCodeableConcept
                                                                        Is Modifierfalse
                                                                        Must Supporttrue
                                                                        Summarytrue
                                                                        Requirements

                                                                        Need to be able to track the kind of organization that this is - different organization types have different uses.

                                                                        LabelType of the Organization
                                                                        Pattern Value{
                                                                          "coding" : [{
                                                                            "system" : "http://terminology.hl7.org/CodeSystem/organization-type",
                                                                            "code" : "ins"
                                                                          }]
                                                                        }
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        1052. Bundle.entry:payer.resource.name
                                                                        Definition

                                                                        A name associated with the organization.

                                                                        ShortMax 255 Characters
                                                                        Comments

                                                                        If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

                                                                        Control1..1
                                                                        This element is affected by the following invariants: org-1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supporttrue
                                                                        Summarytrue
                                                                        Requirements

                                                                        Need to use the name as the label of the organization.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        1054. Bundle.entry:payer.resource.alias
                                                                        Definition

                                                                        A list of alternate names that the organization is known as, or was known as in the past.

                                                                        ShortA list of alternate names that the organization is known as, or was known as in the past
                                                                        Comments

                                                                        There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

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

                                                                        Over time locations and organizations go through many changes and can be known by different names.

                                                                        For searching knowing previous names that the organization was known by can be very useful.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        1056. Bundle.entry:payer.resource.telecom
                                                                        Definition

                                                                        A contact detail for the organization.

                                                                        ShortA contact detail for the organization
                                                                        Comments

                                                                        The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                                                                        Control1..*
                                                                        This element is affected by the following invariants: org-3
                                                                        TypeContactPoint
                                                                        Is Modifierfalse
                                                                        Must Supporttrue
                                                                        Summaryfalse
                                                                        Requirements

                                                                        Human contact for the organization.

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                                                                        SlicingThis element introduces a set of slices on Bundle.entry.resource.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                        • value @ system
                                                                        • 1058. Bundle.entry:payer.resource.telecom.id
                                                                          Definition

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

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          Typeid
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          1060. Bundle.entry:payer.resource.telecom.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 Bundle.entry.resource.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 1062. Bundle.entry:payer.resource.telecom.system
                                                                            Definition

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

                                                                            Shortphone | fax | email | pager | url | sms | other
                                                                            Control0..1
                                                                            This element is affected by the following invariants: cpt-2
                                                                            BindingThe codes SHALL be taken from ContactPointSystem
                                                                            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
                                                                            Typecode
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Must Supporttrue
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            1064. Bundle.entry:payer.resource.telecom.value
                                                                            Definition

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

                                                                            ShortThe actual contact point details
                                                                            Comments

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

                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            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()))
                                                                            1066. Bundle.entry:payer.resource.telecom.use
                                                                            Definition

                                                                            Identifies the purpose for the contact point.

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

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

                                                                            Control0..1
                                                                            BindingThe codes SHALL be taken from ContactPointUse
                                                                            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                                                            Typecode
                                                                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            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()))
                                                                            1068. Bundle.entry:payer.resource.telecom.rank
                                                                            Definition

                                                                            Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                            ShortSpecify preferred order of use (1 = highest)
                                                                            Comments

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

                                                                            Control0..1
                                                                            TypepositiveInt
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            1070. Bundle.entry:payer.resource.telecom.period
                                                                            Definition

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

                                                                            ShortTime period when the contact point was/is in use
                                                                            Control0..1
                                                                            TypePeriod
                                                                            Is Modifierfalse
                                                                            Summarytrue
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            1072. Bundle.entry:payer.resource.telecom:Phone
                                                                            Slice NamePhone
                                                                            Definition

                                                                            A contact detail for the organization.

                                                                            ShortA contact detail for the organization
                                                                            Comments

                                                                            The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                                                                            Control1..*
                                                                            This element is affected by the following invariants: org-3
                                                                            TypeContactPoint
                                                                            Is Modifierfalse
                                                                            Must Supporttrue
                                                                            Summaryfalse
                                                                            Requirements

                                                                            Human contact for the organization.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                                                                            1074. Bundle.entry:payer.resource.telecom:Phone.id
                                                                            Definition

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

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            Typeid
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            1076. Bundle.entry:payer.resource.telecom:Phone.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 Bundle.entry.resource.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 1078. Bundle.entry:payer.resource.telecom:Phone.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.3.0)
                                                                              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()))
                                                                              1080. Bundle.entry:payer.resource.telecom:Phone.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).

                                                                              ShortPhone (10 digit numeric values only)
                                                                              Comments

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

                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              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()))
                                                                              1082. Bundle.entry:payer.resource.telecom:Phone.use
                                                                              Definition

                                                                              Identifies the purpose for the contact point.

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

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

                                                                              Control0..1
                                                                              BindingThe codes SHALL be taken from ContactPointUse
                                                                              (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                                                              Typecode
                                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              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()))
                                                                              1084. Bundle.entry:payer.resource.telecom:Phone.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()))
                                                                              1086. Bundle.entry:payer.resource.telecom:Phone.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()))
                                                                              1088. Bundle.entry:payer.resource.telecom:Fax
                                                                              Slice NameFax
                                                                              Definition

                                                                              A contact detail for the organization.

                                                                              ShortA contact detail for the organization
                                                                              Comments

                                                                              The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

                                                                              Control0..*
                                                                              This element is affected by the following invariants: org-3
                                                                              TypeContactPoint
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Summaryfalse
                                                                              Requirements

                                                                              Human contact for the organization.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                                                                              1090. Bundle.entry:payer.resource.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
                                                                              Typeid
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              1092. Bundle.entry:payer.resource.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 Bundle.entry.resource.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 1094. Bundle.entry:payer.resource.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.3.0)
                                                                                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()))
                                                                                1096. Bundle.entry:payer.resource.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).

                                                                                ShortFax (10 digit numeric values only)
                                                                                Comments

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

                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                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()))
                                                                                1098. Bundle.entry:payer.resource.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..1
                                                                                BindingThe codes SHALL be taken from ContactPointUse
                                                                                (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                                                                Typecode
                                                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                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()))
                                                                                1100. Bundle.entry:payer.resource.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()))
                                                                                1102. Bundle.entry:payer.resource.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()))
                                                                                1104. Bundle.entry:payer.resource.address
                                                                                Definition

                                                                                An address for the organization.

                                                                                ShortAddress is required for Practice Organization and Site of Treatment
                                                                                Comments

                                                                                Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

                                                                                Control0..*
                                                                                This element is affected by the following invariants: org-2
                                                                                TypeAddress
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                Summaryfalse
                                                                                Requirements

                                                                                May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                                                                                1106. Bundle.entry:payer.resource.address.id
                                                                                Definition

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

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                Typeid
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                1108. Bundle.entry:payer.resource.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 Bundle.entry.resource.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 1110. Bundle.entry:payer.resource.address.use
                                                                                  Definition

                                                                                  The purpose of this address.

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

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

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

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

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

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

                                                                                  Example<br/><b>General</b>:home
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  1112. Bundle.entry:payer.resource.address.type
                                                                                  Definition

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

                                                                                  Shortpostal | physical | both
                                                                                  Comments

                                                                                  The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

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

                                                                                  The type of an address (physical / postal).

                                                                                  Typecode
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Example<br/><b>General</b>:both
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  1114. Bundle.entry:payer.resource.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()))
                                                                                  1116. Bundle.entry:payer.resource.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.

                                                                                  ShortMax 255 Characters
                                                                                  Control1..3
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  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()))
                                                                                  1118. Bundle.entry:payer.resource.address.city
                                                                                  Definition

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

                                                                                  ShortMax 30 Characters
                                                                                  Control1..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  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()))
                                                                                  1120. Bundle.entry:payer.resource.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()))
                                                                                  1122. Bundle.entry:payer.resource.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).

                                                                                  ShortStandard state 2 characters (Ex: CA, AZ, NC..)
                                                                                  Control1..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Alternate NamesProvince, Territory
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  1124. Bundle.entry:payer.resource.address.postalCode
                                                                                  Definition

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

                                                                                  ShortMax 10 Characters
                                                                                  Control1..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  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()))
                                                                                  1126. Bundle.entry:payer.resource.address.country
                                                                                  Definition

                                                                                  Country - a nation as commonly understood or generally accepted.

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

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

                                                                                  Control0..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  1128. Bundle.entry:payer.resource.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()))
                                                                                  1130. Bundle.entry:payer.resource.partOf
                                                                                  Definition

                                                                                  The organization of which this organization forms a part.

                                                                                  ShortThe organization of which this organization forms a part
                                                                                  Control0..1
                                                                                  TypeReference(Organization)
                                                                                  Is Modifierfalse
                                                                                  Must Supportfalse
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Need to be able to track the hierarchy of organizations within an organization.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  1132. Bundle.entry:payer.resource.contact
                                                                                  Definition

                                                                                  Contact for the organization for a certain purpose.

                                                                                  ShortContact is required for Practice Organization
                                                                                  Comments

                                                                                  Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

                                                                                  Control0..*
                                                                                  TypeBackboneElement
                                                                                  Is Modifierfalse
                                                                                  Must Supporttrue
                                                                                  Summaryfalse
                                                                                  Requirements

                                                                                  Need to keep track of assigned contact points within bigger organization.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                                  1134. Bundle.entry:payer.resource.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
                                                                                  1136. Bundle.entry:payer.resource.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())
                                                                                  1138. Bundle.entry:payer.resource.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())
                                                                                  1140. Bundle.entry:payer.resource.contact.purpose
                                                                                  Definition

                                                                                  Indicates a purpose for which the contact can be reached.

                                                                                  ShortThe type of contact
                                                                                  Control0..1
                                                                                  BindingUnless not suitable, these codes SHALL be taken from ContactEntityType
                                                                                  (extensible to http://hl7.org/fhir/ValueSet/contactentity-type)

                                                                                  The purpose for which you would contact a contact party.

                                                                                  TypeCodeableConcept
                                                                                  Is Modifierfalse
                                                                                  Must Supportfalse
                                                                                  Summaryfalse
                                                                                  Requirements

                                                                                  Need to distinguish between multiple contact persons.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  1142. Bundle.entry:payer.resource.contact.name
                                                                                  Definition

                                                                                  A name associated with the contact.

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

                                                                                  Need to be able to track the person by name.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  1144. Bundle.entry:payer.resource.contact.name.id
                                                                                  Definition

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

                                                                                  ShortUnique id for inter-element referencing
                                                                                  Control0..1
                                                                                  Typeid
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  1146. Bundle.entry:payer.resource.contact.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 Bundle.entry.resource.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 1148. Bundle.entry:payer.resource.contact.name.use
                                                                                    Definition

                                                                                    Identifies the purpose for this name.

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

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

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

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

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    1150. Bundle.entry:payer.resource.contact.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()))
                                                                                    1152. Bundle.entry:payer.resource.contact.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.

                                                                                    ShortMax 40 Characters
                                                                                    Comments

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

                                                                                    Control1..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Must Supporttrue
                                                                                    Summarytrue
                                                                                    Alternate Namessurname
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    1154. Bundle.entry:payer.resource.contact.name.given
                                                                                    Definition

                                                                                    Given name.

                                                                                    ShortMax 80 Characters
                                                                                    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.

                                                                                    Control1..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Must Supporttrue
                                                                                    Summarytrue
                                                                                    Alternate Namesfirst name, middle name
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    1156. Bundle.entry:payer.resource.contact.name.prefix
                                                                                    Definition

                                                                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                                    ShortParts that come before the name
                                                                                    Control0..*
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    1158. Bundle.entry:payer.resource.contact.name.suffix
                                                                                    Definition

                                                                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                                    ShortParts that come after the name
                                                                                    Control0..*
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    1160. Bundle.entry:payer.resource.contact.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()))
                                                                                    1162. Bundle.entry:payer.resource.contact.telecom
                                                                                    Definition

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

                                                                                    ShortRequired for Practice Organization
                                                                                    Control1..*
                                                                                    TypeContactPoint
                                                                                    Is Modifierfalse
                                                                                    Must Supporttrue
                                                                                    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()))
                                                                                    SlicingThis element introduces a set of slices on Bundle.entry.resource.contact.telecom. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                                    • value @ system
                                                                                    • 1164. Bundle.entry:payer.resource.contact.telecom.id
                                                                                      Definition

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

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..1
                                                                                      Typeid
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      1166. Bundle.entry:payer.resource.contact.telecom.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 1168. Bundle.entry:payer.resource.contact.telecom.system
                                                                                        Definition

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

                                                                                        Shortphone | fax | email | pager | url | sms | other
                                                                                        Control0..1
                                                                                        This element is affected by the following invariants: cpt-2
                                                                                        BindingThe codes SHALL be taken from ContactPointSystem
                                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
                                                                                        Typecode
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Must Supporttrue
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        1170. Bundle.entry:payer.resource.contact.telecom.value
                                                                                        Definition

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

                                                                                        ShortThe actual contact point details
                                                                                        Comments

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

                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        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()))
                                                                                        1172. Bundle.entry:payer.resource.contact.telecom.use
                                                                                        Definition

                                                                                        Identifies the purpose for the contact point.

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

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

                                                                                        Control0..1
                                                                                        BindingThe codes SHALL be taken from ContactPointUse
                                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                                                                        Typecode
                                                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        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()))
                                                                                        1174. Bundle.entry:payer.resource.contact.telecom.rank
                                                                                        Definition

                                                                                        Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                        ShortSpecify preferred order of use (1 = highest)
                                                                                        Comments

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

                                                                                        Control0..1
                                                                                        TypepositiveInt
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        1176. Bundle.entry:payer.resource.contact.telecom.period
                                                                                        Definition

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

                                                                                        ShortTime period when the contact point was/is in use
                                                                                        Control0..1
                                                                                        TypePeriod
                                                                                        Is Modifierfalse
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        1178. Bundle.entry:payer.resource.contact.telecom:Phone
                                                                                        Slice NamePhone
                                                                                        Definition

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

                                                                                        ShortContact details (telephone, email, etc.) for a contact
                                                                                        Control1..*
                                                                                        TypeContactPoint
                                                                                        Is Modifierfalse
                                                                                        Must Supporttrue
                                                                                        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()))
                                                                                        1180. Bundle.entry:payer.resource.contact.telecom:Phone.id
                                                                                        Definition

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

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..1
                                                                                        Typeid
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        1182. Bundle.entry:payer.resource.contact.telecom:Phone.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 1184. Bundle.entry:payer.resource.contact.telecom:Phone.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.3.0)
                                                                                          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()))
                                                                                          1186. Bundle.entry:payer.resource.contact.telecom:Phone.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).

                                                                                          ShortPhone (10 digit numeric values only)
                                                                                          Comments

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

                                                                                          Control0..1
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          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()))
                                                                                          1188. Bundle.entry:payer.resource.contact.telecom:Phone.use
                                                                                          Definition

                                                                                          Identifies the purpose for the contact point.

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

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

                                                                                          Control0..1
                                                                                          BindingThe codes SHALL be taken from ContactPointUse
                                                                                          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                                                                          Typecode
                                                                                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          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()))
                                                                                          1190. Bundle.entry:payer.resource.contact.telecom:Phone.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()))
                                                                                          1192. Bundle.entry:payer.resource.contact.telecom:Phone.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()))
                                                                                          1194. Bundle.entry:payer.resource.contact.telecom:Fax
                                                                                          Slice NameFax
                                                                                          Definition

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

                                                                                          ShortContact details (telephone, email, etc.) for a contact
                                                                                          Control0..*
                                                                                          TypeContactPoint
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          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()))
                                                                                          1196. Bundle.entry:payer.resource.contact.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
                                                                                          Typeid
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          1198. Bundle.entry:payer.resource.contact.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                          • value @ url
                                                                                          • 1200. Bundle.entry:payer.resource.contact.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.3.0)
                                                                                            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()))
                                                                                            1202. Bundle.entry:payer.resource.contact.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).

                                                                                            ShortFax (10 digit numeric values only)
                                                                                            Comments

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

                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            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()))
                                                                                            1204. Bundle.entry:payer.resource.contact.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..1
                                                                                            BindingThe codes SHALL be taken from ContactPointUse
                                                                                            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                                                                                            Typecode
                                                                                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            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()))
                                                                                            1206. Bundle.entry:payer.resource.contact.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()))
                                                                                            1208. Bundle.entry:payer.resource.contact.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()))
                                                                                            1210. Bundle.entry:payer.resource.contact.telecom:Email
                                                                                            Slice NameEmail
                                                                                            Definition

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

                                                                                            ShortContact details (telephone, email, etc.) for a contact
                                                                                            Control0..*
                                                                                            TypeContactPoint
                                                                                            Is Modifierfalse
                                                                                            Must Supporttrue
                                                                                            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()))
                                                                                            1212. Bundle.entry:payer.resource.contact.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
                                                                                            Typeid
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            1214. Bundle.entry:payer.resource.contact.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 Bundle.entry.resource.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ url
                                                                                            • 1216. Bundle.entry:payer.resource.contact.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.3.0)
                                                                                              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()))
                                                                                              1218. Bundle.entry:payer.resource.contact.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).

                                                                                              ShortEmail format
                                                                                              Comments

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

                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              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()))
                                                                                              1220. Bundle.entry:payer.resource.contact.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.3.0)
                                                                                              Typecode
                                                                                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              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()))
                                                                                              1222. Bundle.entry:payer.resource.contact.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()))
                                                                                              1224. Bundle.entry:payer.resource.contact.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()))
                                                                                              1226. Bundle.entry:payer.resource.contact.address
                                                                                              Definition

                                                                                              Visiting or postal addresses for the contact.

                                                                                              ShortVisiting or postal addresses for the contact
                                                                                              Control0..1
                                                                                              TypeAddress
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              May need to keep track of a contact party's address for contacting, billing or reporting requirements.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              1228. Bundle.entry:payer.resource.endpoint
                                                                                              Definition

                                                                                              Technical endpoints providing access to services operated for the organization.

                                                                                              ShortTechnical endpoints providing access to services operated for the organization
                                                                                              Control0..*
                                                                                              TypeReference(Endpoint)
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              1230. Bundle.entry:payer.search
                                                                                              Definition

                                                                                              Information about the search process that lead to the creation of this entry.

                                                                                              ShortSearch related information
                                                                                              Control0..0
                                                                                              This element is affected by the following invariants: bdl-2
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                                              1237. Bundle.entry:payer.request
                                                                                              Definition

                                                                                              Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

                                                                                              ShortAdditional execution information (transaction/batch/history)
                                                                                              Control0..0
                                                                                              This element is affected by the following invariants: bdl-3
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                                              1248. Bundle.entry:payer.response
                                                                                              Definition

                                                                                              Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

                                                                                              ShortResults of execution (transaction/batch/history)
                                                                                              Control0..0
                                                                                              This element is affected by the following invariants: bdl-4
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                                                                                              1258. Bundle.signature
                                                                                              Definition

                                                                                              Digital Signature - base64 encoded. XML-DSig or a JWT.

                                                                                              ShortDigital Signature
                                                                                              Comments

                                                                                              The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.

                                                                                              Control0..1
                                                                                              TypeSignature
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.

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