Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Logical Model: PatientInsurance - Detailed Descriptions

Active as of 2023-03-01

Definitions for the athena-patientInsurance-profile logical model.

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

0. athena-patientInsurance-profile
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. athena-patientInsurance-profile.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.

Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
4. athena-patientInsurance-profile.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
Comments

Unique Id for this particular athena-patientInsurance-profile.

Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
6. athena-patientInsurance-profile.pid
Definition

Patient identifier for patientInsurance data.

ShortPID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient resource.
Comments

Patient-identifier.

Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
8. athena-patientInsurance-profile.patient
Definition

Who or what the patientInsurance is about. The patientInsurance can be about a person.

ShortWho/what is the patient of the patientInsurance
Control0..1
TypeReference(Patient)
10. athena-patientInsurance-profile.patient.reference
Definition

Who or what the patientInsurance is about. The patientInsurance can be about a person.

ShortReference to the Patient
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. athena-patientInsurance-profile.patient.display
Definition

Patient name for the patientInsurance is about.

ShortPatient name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. athena-patientInsurance-profile.patientProfileId
Definition

Internal ID of patient used in non-clinical practice management data.

ShortPatient specific id for practice management data including financial information
Comments

Patient profile ID

Control1..1
TypeunsignedInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
16. athena-patientInsurance-profile.insuranceCarrier
Definition

Reference to Organization

ShortInsurance carrier refernce
Control0..1
TypeReference(Organization)
18. athena-patientInsurance-profile.insuranceCarrier.reference
Definition

Reference to Organization

ShortInsurance Carrier Id refering to Organization
Comments

Insurance Carrier Id refering to Organization

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. athena-patientInsurance-profile.insuranceCarrier.display
Definition

Name of the the insurance Carrier

ShortInsurance carrier Name
Comments

Insurance carrier Name

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. athena-patientInsurance-profile.patientSameAsGuarantor
Definition

Patient relationship with Guarantor

ShortPatient relationship with Guarantor
Comments

Relations with patient

Control0..1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. athena-patientInsurance-profile.guarantor
Definition

Guarantor reference for patient.

ShortReference to RelatedPerson
Control0..1
TypeReference(http://hl7.org/fhir/StructureDefinition/guarantor)
26. athena-patientInsurance-profile.guarantor.reference
Definition

Reference to guarantor

ShortGuarantorId refering to Related person
Comments

DoctorId refering to guarantor

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. athena-patientInsurance-profile.guarantor.display
Definition

Name of the the guarantor

ShortGuarantor Name
Comments

Guarantor Name

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. athena-patientInsurance-profile.orderForClaims
Definition

Claim order

ShortNumber of Claim orders
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. athena-patientInsurance-profile.inActive
Definition

Status of Insurance Plan

ShortInsurance status
Comments

PatientInsurance status

Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. athena-patientInsurance-profile.insuredID
Definition

Insured ID for the Insurance.

ShortInsured ID for the Insurance.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. athena-patientInsurance-profile.practitioner
Definition

Reference to Practitioner

ShortPractitioner reference for insurance.
Control0..1
TypeReference(Practitioner)
38. athena-patientInsurance-profile.practitioner.reference
Definition

Reference to Practitioner

ShortDoctorId refering to Practitioner
Comments

DoctorId refering to Practitioner

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. athena-patientInsurance-profile.practitioner.display
Definition

Name of the the Practitioner

ShortPractitioner Name
Comments

Practitioner Name

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. athena-patientInsurance-profile.facility
Definition

Name with which Doctor or facility is associated

ShortFacility associated to insurance plan
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. athena-patientInsurance-profile.financialClass
Definition

Financial Class description

ShortFinancial Class description
Comments

Financial Class description

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. athena-patientInsurance-profile.insuranceGroup
Definition

Insurance Group description

ShortInsurance Group
Comments

Insurance Group

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

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

0. athena-patientInsurance-profile
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. athena-patientInsurance-profile.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.

Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
4. athena-patientInsurance-profile.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
Comments

Unique Id for this particular athena-patientInsurance-profile.

Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
6. athena-patientInsurance-profile.pid
Definition

Patient identifier for patientInsurance data.

ShortPID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient resource.
Comments

Patient-identifier.

Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
8. athena-patientInsurance-profile.patient
Definition

Who or what the patientInsurance is about. The patientInsurance can be about a person.

ShortWho/what is the patient of the patientInsurance
Control0..1
TypeReference(Patient)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
10. athena-patientInsurance-profile.patient.reference
Definition

Who or what the patientInsurance is about. The patientInsurance can be about a person.


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.

ShortReference to the PatientLiteral reference, Relative, internal or absolute URL
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Control0..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. athena-patientInsurance-profile.patient.display
Definition

Patient name for the patientInsurance is about.


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

ShortPatient nameText 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()))
14. athena-patientInsurance-profile.patientProfileId
Definition

Internal ID of patient used in non-clinical practice management data.

ShortPatient specific id for practice management data including financial information
Comments

Patient profile ID

Control1..1
TypeunsignedInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
16. athena-patientInsurance-profile.insuranceCarrier
Definition

Reference to Organization

ShortInsurance carrier refernce
Control0..1
TypeReference(Organization)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
18. athena-patientInsurance-profile.insuranceCarrier.reference
Definition

Reference to Organization


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.

ShortInsurance Carrier Id refering to OrganizationLiteral reference, Relative, internal or absolute URL
Comments

Insurance Carrier Id refering to Organization


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()))
20. athena-patientInsurance-profile.insuranceCarrier.display
Definition

Name of the the insurance Carrier


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

ShortInsurance carrier NameText alternative for the resource
Comments

Insurance carrier Name


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()))
22. athena-patientInsurance-profile.patientSameAsGuarantor
Definition

Patient relationship with Guarantor

ShortPatient relationship with Guarantor
Comments

Relations with patient

Control0..1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. athena-patientInsurance-profile.guarantor
Definition

Guarantor reference for patient.

ShortReference to RelatedPerson
Control0..1
TypeReference(http://hl7.org/fhir/StructureDefinition/guarantor)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
26. athena-patientInsurance-profile.guarantor.reference
Definition

Reference to guarantor


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.

ShortGuarantorId refering to Related personLiteral reference, Relative, internal or absolute URL
Comments

DoctorId refering to guarantor


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()))
28. athena-patientInsurance-profile.guarantor.display
Definition

Name of the the guarantor


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

ShortGuarantor NameText alternative for the resource
Comments

Guarantor Name


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()))
30. athena-patientInsurance-profile.orderForClaims
Definition

Claim order

ShortNumber of Claim orders
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. athena-patientInsurance-profile.inActive
Definition

Status of Insurance Plan

ShortInsurance status
Comments

PatientInsurance status

Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. athena-patientInsurance-profile.insuredID
Definition

Insured ID for the Insurance.

ShortInsured ID for the Insurance.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. athena-patientInsurance-profile.practitioner
Definition

Reference to Practitioner

ShortPractitioner reference for insurance.
Control0..1
TypeReference(Practitioner)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
38. athena-patientInsurance-profile.practitioner.reference
Definition

Reference to Practitioner


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.

ShortDoctorId refering to PractitionerLiteral reference, Relative, internal or absolute URL
Comments

DoctorId refering to Practitioner


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()))
40. athena-patientInsurance-profile.practitioner.display
Definition

Name of the the Practitioner


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

ShortPractitioner NameText alternative for the resource
Comments

Practitioner Name


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()))
42. athena-patientInsurance-profile.facility
Definition

Name with which Doctor or facility is associated

ShortFacility associated to insurance plan
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. athena-patientInsurance-profile.financialClass
Definition

Financial Class description

ShortFinancial Class description
Comments

Financial Class description

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. athena-patientInsurance-profile.insuranceGroup
Definition

Insurance Group description

ShortInsurance Group
Comments

Insurance Group

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

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

0. athena-patientInsurance-profile
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. athena-patientInsurance-profile.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.

Control1..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
4. athena-patientInsurance-profile.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
Comments

Unique Id for this particular athena-patientInsurance-profile.

Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
6. athena-patientInsurance-profile.pid
Definition

Patient identifier for patientInsurance data.

ShortPID is internal numeric value used in the Chart module and clinical data. This will be the same as the resource id in the Patient resource.
Comments

Patient-identifier.

Control1..1
Typeinteger
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
8. athena-patientInsurance-profile.patient
Definition

Who or what the patientInsurance is about. The patientInsurance can be about a person.

ShortWho/what is the patient of the patientInsurance
Control0..1
TypeReference(Patient)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
10. athena-patientInsurance-profile.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
12. athena-patientInsurance-profile.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())
SlicingThis element introduces a set of slices on athena-patientInsurance-profile.patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 14. athena-patientInsurance-profile.patient.reference
    Definition

    Who or what the patientInsurance is about. The patientInsurance can be about a person.

    ShortReference to the Patient
    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()))
    16. athena-patientInsurance-profile.patient.type
    Definition

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

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

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

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

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ResourceType
    (extensible to http://hl7.org/fhir/ValueSet/resource-types)

    Aa resource (or, for logical models, the URI of the logical model).

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

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

    ShortLogical reference, when literal reference is not known
    Comments

    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

    Patient name for the patientInsurance is about.

    ShortPatient name
    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()))
    22. athena-patientInsurance-profile.patientProfileId
    Definition

    Internal ID of patient used in non-clinical practice management data.

    ShortPatient specific id for practice management data including financial information
    Comments

    Patient profile ID

    Control1..1
    TypeunsignedInt
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    24. athena-patientInsurance-profile.insuranceCarrier
    Definition

    Reference to Organization

    ShortInsurance carrier refernce
    Control0..1
    TypeReference(Organization)
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
    26. athena-patientInsurance-profile.insuranceCarrier.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
    28. athena-patientInsurance-profile.insuranceCarrier.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 athena-patientInsurance-profile.insuranceCarrier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 30. athena-patientInsurance-profile.insuranceCarrier.reference
      Definition

      Reference to Organization

      ShortInsurance Carrier Id refering to Organization
      Comments

      Insurance Carrier Id refering to Organization

      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()))
      32. athena-patientInsurance-profile.insuranceCarrier.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)

      Aa resource (or, for logical models, the URI of the logical model).

      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()))
      34. athena-patientInsurance-profile.insuranceCarrier.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()))
      36. athena-patientInsurance-profile.insuranceCarrier.display
      Definition

      Name of the the insurance Carrier

      ShortInsurance carrier Name
      Comments

      Insurance carrier 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()))
      38. athena-patientInsurance-profile.patientSameAsGuarantor
      Definition

      Patient relationship with Guarantor

      ShortPatient relationship with Guarantor
      Comments

      Relations with patient

      Control0..1
      TypeunsignedInt
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. athena-patientInsurance-profile.guarantor
      Definition

      Guarantor reference for patient.

      ShortReference to RelatedPerson
      Control0..1
      TypeReference(http://hl7.org/fhir/StructureDefinition/guarantor)
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
      42. athena-patientInsurance-profile.guarantor.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
      44. athena-patientInsurance-profile.guarantor.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 athena-patientInsurance-profile.guarantor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 46. athena-patientInsurance-profile.guarantor.reference
        Definition

        Reference to guarantor

        ShortGuarantorId refering to Related person
        Comments

        DoctorId refering to guarantor

        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()))
        48. athena-patientInsurance-profile.guarantor.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)

        Aa resource (or, for logical models, the URI of the logical model).

        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()))
        50. athena-patientInsurance-profile.guarantor.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()))
        52. athena-patientInsurance-profile.guarantor.display
        Definition

        Name of the the guarantor

        ShortGuarantor Name
        Comments

        Guarantor 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()))
        54. athena-patientInsurance-profile.orderForClaims
        Definition

        Claim order

        ShortNumber of Claim orders
        Control0..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        56. athena-patientInsurance-profile.inActive
        Definition

        Status of Insurance Plan

        ShortInsurance status
        Comments

        PatientInsurance status

        Control0..1
        Typeboolean
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        58. athena-patientInsurance-profile.insuredID
        Definition

        Insured ID for the Insurance.

        ShortInsured ID for the Insurance.
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        60. athena-patientInsurance-profile.practitioner
        Definition

        Reference to Practitioner

        ShortPractitioner reference for insurance.
        Control0..1
        TypeReference(Practitioner)
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
        62. athena-patientInsurance-profile.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
        64. athena-patientInsurance-profile.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())
        SlicingThis element introduces a set of slices on athena-patientInsurance-profile.practitioner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 66. athena-patientInsurance-profile.practitioner.reference
          Definition

          Reference to Practitioner

          ShortDoctorId refering to Practitioner
          Comments

          DoctorId refering to Practitioner

          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()))
          68. athena-patientInsurance-profile.practitioner.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)

          Aa resource (or, for logical models, the URI of the logical model).

          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()))
          70. athena-patientInsurance-profile.practitioner.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()))
          72. athena-patientInsurance-profile.practitioner.display
          Definition

          Name of the the Practitioner

          ShortPractitioner Name
          Comments

          Practitioner 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()))
          74. athena-patientInsurance-profile.facility
          Definition

          Name with which Doctor or facility is associated

          ShortFacility associated to insurance plan
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          76. athena-patientInsurance-profile.financialClass
          Definition

          Financial Class description

          ShortFinancial Class description
          Comments

          Financial Class description

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          78. athena-patientInsurance-profile.insuranceGroup
          Definition

          Insurance Group description

          ShortInsurance Group
          Comments

          Insurance Group

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