Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Logical Model: Profile - Athena Custom Charge

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-charge-profile Version: 23.1.0
Active as of 2023-03-01 Computable Name: Charge

The Charge describes a health insurance offering comprised of a list of covered benefits (i.e. the product), costs associated with those benefits (i.e. the plan), and additional information about the offering, such as who it is owned and administered by, a coverage area, contact information, etc..


This custom Charge is part of the set of resource profiles supported by the API Server used with the athenaPractice product starting with version 23.0. This is not a FHIR Conformant Resource. It further describes read and search capabilities of these products.
Note: Create and Update operations are NOT supported for this resource.

Overview

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track Charges for a patient, cost centers, etc.

Scope and Usage

Tracking Financial information is vital in Patient Administration and Finance systems in most Healthcare Organizations. The resource ChargeItem describes the charge for provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the Charge is to enable the billing process and internal cost allocation. They are created as soon as the products are planned or provisioned, references to Encounters and/or Accounts can be maintained in a later process step.. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Charge resource is used to track variour charges for a patient and cost centers. It is derived from PatientVisit, Guarantor, PatientProfile, DoctorFacility, patientVisitProc etc. tables in athenaPractice.

Example

Example for the athena-charge-profile Profile.

Charge Example

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-charge-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID 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.
... patient 0..1 Reference(Patient) Who/what is the patient of the charge
.... reference 0..1 string Reference to the Patient
.... display 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... searchName 0..1 string Patient Name for Search
... ticketNumber 0..1 string The ticket number for this visit.
... batchName 0..1 string The batch associated to the charge file.
... dateOfServiceFrom 0..1 dateTime The start date of service for this procedure.
... dateOfServiceTo 0..1 dateTime The stop date of service for this procedure.
... code 0..1 string Procedure code
... cptCode 0..1 string CPT Code
... units 0..1 decimal Unit information
... codeQualifier 0..1 string Procedure Code Qualifier for CPT Code. This column should be linked to the MedLists table MedListsId column with a TableName of ProcedureCodeQualifier.
... modifier1 0..1 string MedListsId for Modifier #1
... modifier2 0..1 string MedListsId for Modifier #2
... modifier3 0..1 string MedListsId for Modifier #3
... modifier4 0..1 string MedListsId for Modifier #4
... fee 0..1 Money The charge amount for the procedure
.... value 0..1 decimal Charge amount
.... currency 0..1 code Currency
... totalFee 0..1 Money Total amount distribution
.... value 0..1 decimal Fee multiplied by Calculated Units.
.... currency 0..1 code Currency
... allowed 0..1 Money The allowed amount for this procedure.
.... value 0..1 decimal Allowed amount for the procedure
.... currency 0..1 code Currency
... totalAllowed 0..1 Money Allowed multiplied by Calculated Units.
.... value 0..1 decimal Total allowed amount value
.... currency 0..1 code Currency
... rvu 0..1 string RVU amount for this procedure's fee
... rvuAllowed 0..1 string The RVU allowed for the procedure's fee
... productCode 0..1 string Product code
... productCodeProcedureCodeQualifier 0..1 string Product Code Procedure Code Qualifier
... revenueCode 0..1 string Revenue Code
... procedureCodeDescription 0..1 string The description of this procedure.
... coPayAmount 0..1 Money The coPayAmount amount for this procedure.
.... value 0..1 decimal The coPayAmount amount for this procedure.
.... currency 0..1 code Currency
... placeOfService 0..1 string The ID of the place of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of PlaceOfServiceCodes.
... typeOfService 0..1 integer The ID of the type of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of TypeOfServiceCodes.
... authDetailNum 0..1 string The authorization number for this procedure.
... authDate 0..1 dateTime Authrization Date in Procedure Level
... referralNumber 0..1 string Referral Number in Procedure Level
... referralDate 0..1 dateTime The optional issue date of the authorization or referral number for the case. Only the date portion of datetime is used.
... doctor 0..1 Reference(Practitioner) Practitioner reference for insurance.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... visitFacility 0..1 string Facility Information
... visitCompany 0..1 string Facility group for this visit
... visitReferringDoctor 0..1 Reference(Practitioner) Referring doctor for the visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeServiceFacility 0..1 string Service facility group for the visit
... chargeRenderingProvider 0..1 Reference(Practitioner) Rendering doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeSupervisingProvider 0..1 Reference(Practitioner) Supervising doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeReferringProvider 0..1 Reference(Practitioner) Referring doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeOrderingProvider 0..1 Reference(Practitioner) Ordering doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-charge-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID 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.
... patient C 0..1 Reference(Patient) Who/what is the patient of the charge
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string Reference to the Patient
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... searchName 0..1 string Patient Name for Search
... ticketNumber 0..1 string The ticket number for this visit.
... batchName 0..1 string The batch associated to the charge file.
... dateOfServiceFrom 0..1 dateTime The start date of service for this procedure.
... dateOfServiceTo 0..1 dateTime The stop date of service for this procedure.
... code 0..1 string Procedure code
... cptCode 0..1 string CPT Code
... units 0..1 decimal Unit information
... codeQualifier 0..1 string Procedure Code Qualifier for CPT Code. This column should be linked to the MedLists table MedListsId column with a TableName of ProcedureCodeQualifier.
... modifier1 0..1 string MedListsId for Modifier #1
... modifier2 0..1 string MedListsId for Modifier #2
... modifier3 0..1 string MedListsId for Modifier #3
... modifier4 0..1 string MedListsId for Modifier #4
... fee 0..1 Money The charge amount for the procedure
.... value Σ 0..1 decimal Charge amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalFee 0..1 Money Total amount distribution
.... value Σ 0..1 decimal Fee multiplied by Calculated Units.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... allowed 0..1 Money The allowed amount for this procedure.
.... value Σ 0..1 decimal Allowed amount for the procedure
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalAllowed 0..1 Money Allowed multiplied by Calculated Units.
.... value Σ 0..1 decimal Total allowed amount value
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... rvu 0..1 string RVU amount for this procedure's fee
... rvuAllowed 0..1 string The RVU allowed for the procedure's fee
... productCode 0..1 string Product code
... productCodeProcedureCodeQualifier 0..1 string Product Code Procedure Code Qualifier
... revenueCode 0..1 string Revenue Code
... procedureCodeDescription 0..1 string The description of this procedure.
... coPayAmount 0..1 Money The coPayAmount amount for this procedure.
.... value Σ 0..1 decimal The coPayAmount amount for this procedure.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... placeOfService 0..1 string The ID of the place of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of PlaceOfServiceCodes.
... typeOfService 0..1 integer The ID of the type of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of TypeOfServiceCodes.
... authDetailNum 0..1 string The authorization number for this procedure.
... authDate 0..1 dateTime Authrization Date in Procedure Level
... referralNumber 0..1 string Referral Number in Procedure Level
... referralDate 0..1 dateTime The optional issue date of the authorization or referral number for the case. Only the date portion of datetime is used.
... doctor C 0..1 Reference(Practitioner) Practitioner reference for insurance.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... visitFacility 0..1 string Facility Information
... visitCompany 0..1 string Facility group for this visit
... visitReferringDoctor C 0..1 Reference(Practitioner) Referring doctor for the visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeServiceFacility 0..1 string Service facility group for the visit
... chargeRenderingProvider C 0..1 Reference(Practitioner) Rendering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeSupervisingProvider C 0..1 Reference(Practitioner) Supervising doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeReferringProvider C 0..1 Reference(Practitioner) Referring doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeOrderingProvider C 0..1 Reference(Practitioner) Ordering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-charge-profile.fee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalFee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.allowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalAllowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.coPayAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-charge-profile.patient, athena-charge-profile.doctor, athena-charge-profile.visitReferringDoctor, athena-charge-profile.chargeRenderingProvider, athena-charge-profile.chargeSupervisingProvider, athena-charge-profile.chargeReferringProvider, athena-charge-profile.chargeOrderingProviderSHALL 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'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-charge-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID 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.
... patient C 0..1 Reference(Patient) Who/what is the patient of the charge
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Reference to the Patient
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... searchName 0..1 string Patient Name for Search
... ticketNumber 0..1 string The ticket number for this visit.
... batchName 0..1 string The batch associated to the charge file.
... dateOfServiceFrom 0..1 dateTime The start date of service for this procedure.
... dateOfServiceTo 0..1 dateTime The stop date of service for this procedure.
... code 0..1 string Procedure code
... cptCode 0..1 string CPT Code
... units 0..1 decimal Unit information
... codeQualifier 0..1 string Procedure Code Qualifier for CPT Code. This column should be linked to the MedLists table MedListsId column with a TableName of ProcedureCodeQualifier.
... modifier1 0..1 string MedListsId for Modifier #1
... modifier2 0..1 string MedListsId for Modifier #2
... modifier3 0..1 string MedListsId for Modifier #3
... modifier4 0..1 string MedListsId for Modifier #4
... fee 0..1 Money The charge amount for the procedure
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Charge amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalFee 0..1 Money Total amount distribution
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Fee multiplied by Calculated Units.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... allowed 0..1 Money The allowed amount for this procedure.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Allowed amount for the procedure
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalAllowed 0..1 Money Allowed multiplied by Calculated Units.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Total allowed amount value
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... rvu 0..1 string RVU amount for this procedure's fee
... rvuAllowed 0..1 string The RVU allowed for the procedure's fee
... productCode 0..1 string Product code
... productCodeProcedureCodeQualifier 0..1 string Product Code Procedure Code Qualifier
... revenueCode 0..1 string Revenue Code
... procedureCodeDescription 0..1 string The description of this procedure.
... coPayAmount 0..1 Money The coPayAmount amount for this procedure.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal The coPayAmount amount for this procedure.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... placeOfService 0..1 string The ID of the place of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of PlaceOfServiceCodes.
... typeOfService 0..1 integer The ID of the type of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of TypeOfServiceCodes.
... authDetailNum 0..1 string The authorization number for this procedure.
... authDate 0..1 dateTime Authrization Date in Procedure Level
... referralNumber 0..1 string Referral Number in Procedure Level
... referralDate 0..1 dateTime The optional issue date of the authorization or referral number for the case. Only the date portion of datetime is used.
... doctor C 0..1 Reference(Practitioner) Practitioner reference for insurance.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... visitFacility 0..1 string Facility Information
... visitCompany 0..1 string Facility group for this visit
... visitReferringDoctor C 0..1 Reference(Practitioner) Referring doctor for the visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeServiceFacility 0..1 string Service facility group for the visit
... chargeRenderingProvider C 0..1 Reference(Practitioner) Rendering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeSupervisingProvider C 0..1 Reference(Practitioner) Supervising doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeReferringProvider C 0..1 Reference(Practitioner) Referring doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeOrderingProvider C 0..1 Reference(Practitioner) Ordering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-charge-profile.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.fee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalFee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.allowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalAllowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.coPayAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.doctor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.visitReferringDoctor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeRenderingProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeSupervisingProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeReferringProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeOrderingProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-charge-profile.patient, athena-charge-profile.doctor, athena-charge-profile.visitReferringDoctor, athena-charge-profile.chargeRenderingProvider, athena-charge-profile.chargeSupervisingProvider, athena-charge-profile.chargeReferringProvider, athena-charge-profile.chargeOrderingProviderSHALL 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'))

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 3 elements

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-charge-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID 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.
... patient 0..1 Reference(Patient) Who/what is the patient of the charge
.... reference 0..1 string Reference to the Patient
.... display 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... searchName 0..1 string Patient Name for Search
... ticketNumber 0..1 string The ticket number for this visit.
... batchName 0..1 string The batch associated to the charge file.
... dateOfServiceFrom 0..1 dateTime The start date of service for this procedure.
... dateOfServiceTo 0..1 dateTime The stop date of service for this procedure.
... code 0..1 string Procedure code
... cptCode 0..1 string CPT Code
... units 0..1 decimal Unit information
... codeQualifier 0..1 string Procedure Code Qualifier for CPT Code. This column should be linked to the MedLists table MedListsId column with a TableName of ProcedureCodeQualifier.
... modifier1 0..1 string MedListsId for Modifier #1
... modifier2 0..1 string MedListsId for Modifier #2
... modifier3 0..1 string MedListsId for Modifier #3
... modifier4 0..1 string MedListsId for Modifier #4
... fee 0..1 Money The charge amount for the procedure
.... value 0..1 decimal Charge amount
.... currency 0..1 code Currency
... totalFee 0..1 Money Total amount distribution
.... value 0..1 decimal Fee multiplied by Calculated Units.
.... currency 0..1 code Currency
... allowed 0..1 Money The allowed amount for this procedure.
.... value 0..1 decimal Allowed amount for the procedure
.... currency 0..1 code Currency
... totalAllowed 0..1 Money Allowed multiplied by Calculated Units.
.... value 0..1 decimal Total allowed amount value
.... currency 0..1 code Currency
... rvu 0..1 string RVU amount for this procedure's fee
... rvuAllowed 0..1 string The RVU allowed for the procedure's fee
... productCode 0..1 string Product code
... productCodeProcedureCodeQualifier 0..1 string Product Code Procedure Code Qualifier
... revenueCode 0..1 string Revenue Code
... procedureCodeDescription 0..1 string The description of this procedure.
... coPayAmount 0..1 Money The coPayAmount amount for this procedure.
.... value 0..1 decimal The coPayAmount amount for this procedure.
.... currency 0..1 code Currency
... placeOfService 0..1 string The ID of the place of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of PlaceOfServiceCodes.
... typeOfService 0..1 integer The ID of the type of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of TypeOfServiceCodes.
... authDetailNum 0..1 string The authorization number for this procedure.
... authDate 0..1 dateTime Authrization Date in Procedure Level
... referralNumber 0..1 string Referral Number in Procedure Level
... referralDate 0..1 dateTime The optional issue date of the authorization or referral number for the case. Only the date portion of datetime is used.
... doctor 0..1 Reference(Practitioner) Practitioner reference for insurance.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... visitFacility 0..1 string Facility Information
... visitCompany 0..1 string Facility group for this visit
... visitReferringDoctor 0..1 Reference(Practitioner) Referring doctor for the visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeServiceFacility 0..1 string Service facility group for the visit
... chargeRenderingProvider 0..1 Reference(Practitioner) Rendering doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeSupervisingProvider 0..1 Reference(Practitioner) Supervising doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeReferringProvider 0..1 Reference(Practitioner) Referring doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name
... chargeOrderingProvider 0..1 Reference(Practitioner) Ordering doctor for this visit.
.... reference 0..1 string DoctorId refering to Practitioner
.... display 0..1 string Practitioner Name

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-charge-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID 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.
... patient C 0..1 Reference(Patient) Who/what is the patient of the charge
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string Reference to the Patient
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... searchName 0..1 string Patient Name for Search
... ticketNumber 0..1 string The ticket number for this visit.
... batchName 0..1 string The batch associated to the charge file.
... dateOfServiceFrom 0..1 dateTime The start date of service for this procedure.
... dateOfServiceTo 0..1 dateTime The stop date of service for this procedure.
... code 0..1 string Procedure code
... cptCode 0..1 string CPT Code
... units 0..1 decimal Unit information
... codeQualifier 0..1 string Procedure Code Qualifier for CPT Code. This column should be linked to the MedLists table MedListsId column with a TableName of ProcedureCodeQualifier.
... modifier1 0..1 string MedListsId for Modifier #1
... modifier2 0..1 string MedListsId for Modifier #2
... modifier3 0..1 string MedListsId for Modifier #3
... modifier4 0..1 string MedListsId for Modifier #4
... fee 0..1 Money The charge amount for the procedure
.... value Σ 0..1 decimal Charge amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalFee 0..1 Money Total amount distribution
.... value Σ 0..1 decimal Fee multiplied by Calculated Units.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... allowed 0..1 Money The allowed amount for this procedure.
.... value Σ 0..1 decimal Allowed amount for the procedure
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalAllowed 0..1 Money Allowed multiplied by Calculated Units.
.... value Σ 0..1 decimal Total allowed amount value
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... rvu 0..1 string RVU amount for this procedure's fee
... rvuAllowed 0..1 string The RVU allowed for the procedure's fee
... productCode 0..1 string Product code
... productCodeProcedureCodeQualifier 0..1 string Product Code Procedure Code Qualifier
... revenueCode 0..1 string Revenue Code
... procedureCodeDescription 0..1 string The description of this procedure.
... coPayAmount 0..1 Money The coPayAmount amount for this procedure.
.... value Σ 0..1 decimal The coPayAmount amount for this procedure.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... placeOfService 0..1 string The ID of the place of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of PlaceOfServiceCodes.
... typeOfService 0..1 integer The ID of the type of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of TypeOfServiceCodes.
... authDetailNum 0..1 string The authorization number for this procedure.
... authDate 0..1 dateTime Authrization Date in Procedure Level
... referralNumber 0..1 string Referral Number in Procedure Level
... referralDate 0..1 dateTime The optional issue date of the authorization or referral number for the case. Only the date portion of datetime is used.
... doctor C 0..1 Reference(Practitioner) Practitioner reference for insurance.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... visitFacility 0..1 string Facility Information
... visitCompany 0..1 string Facility group for this visit
... visitReferringDoctor C 0..1 Reference(Practitioner) Referring doctor for the visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeServiceFacility 0..1 string Service facility group for the visit
... chargeRenderingProvider C 0..1 Reference(Practitioner) Rendering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeSupervisingProvider C 0..1 Reference(Practitioner) Supervising doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeReferringProvider C 0..1 Reference(Practitioner) Referring doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name
... chargeOrderingProvider C 0..1 Reference(Practitioner) Ordering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... display Σ 0..1 string Practitioner Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-charge-profile.fee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalFee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.allowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalAllowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.coPayAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-charge-profile.patient, athena-charge-profile.doctor, athena-charge-profile.visitReferringDoctor, athena-charge-profile.chargeRenderingProvider, athena-charge-profile.chargeSupervisingProvider, athena-charge-profile.chargeReferringProvider, athena-charge-profile.chargeOrderingProviderSHALL 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'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. athena-charge-profile 0..* Base Instances of this logical model are not marked to be the target of a Reference
... id SΣ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... pid SΣ 1..1 integer PID 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.
... patient C 0..1 Reference(Patient) Who/what is the patient of the charge
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Reference to the Patient
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Patient name
... patientProfileId SΣ 1..1 unsignedInt Patient specific id for practice management data including financial information
... searchName 0..1 string Patient Name for Search
... ticketNumber 0..1 string The ticket number for this visit.
... batchName 0..1 string The batch associated to the charge file.
... dateOfServiceFrom 0..1 dateTime The start date of service for this procedure.
... dateOfServiceTo 0..1 dateTime The stop date of service for this procedure.
... code 0..1 string Procedure code
... cptCode 0..1 string CPT Code
... units 0..1 decimal Unit information
... codeQualifier 0..1 string Procedure Code Qualifier for CPT Code. This column should be linked to the MedLists table MedListsId column with a TableName of ProcedureCodeQualifier.
... modifier1 0..1 string MedListsId for Modifier #1
... modifier2 0..1 string MedListsId for Modifier #2
... modifier3 0..1 string MedListsId for Modifier #3
... modifier4 0..1 string MedListsId for Modifier #4
... fee 0..1 Money The charge amount for the procedure
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Charge amount
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalFee 0..1 Money Total amount distribution
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Fee multiplied by Calculated Units.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... allowed 0..1 Money The allowed amount for this procedure.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Allowed amount for the procedure
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... totalAllowed 0..1 Money Allowed multiplied by Calculated Units.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal Total allowed amount value
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... rvu 0..1 string RVU amount for this procedure's fee
... rvuAllowed 0..1 string The RVU allowed for the procedure's fee
... productCode 0..1 string Product code
... productCodeProcedureCodeQualifier 0..1 string Product Code Procedure Code Qualifier
... revenueCode 0..1 string Revenue Code
... procedureCodeDescription 0..1 string The description of this procedure.
... coPayAmount 0..1 Money The coPayAmount amount for this procedure.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 0..1 decimal The coPayAmount amount for this procedure.
.... currency Σ 0..1 code Currency
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.

... placeOfService 0..1 string The ID of the place of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of PlaceOfServiceCodes.
... typeOfService 0..1 integer The ID of the type of service for this item. This column should be linked to the MedLists table MedListsId column with a TableName of TypeOfServiceCodes.
... authDetailNum 0..1 string The authorization number for this procedure.
... authDate 0..1 dateTime Authrization Date in Procedure Level
... referralNumber 0..1 string Referral Number in Procedure Level
... referralDate 0..1 dateTime The optional issue date of the authorization or referral number for the case. Only the date portion of datetime is used.
... doctor C 0..1 Reference(Practitioner) Practitioner reference for insurance.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... visitFacility 0..1 string Facility Information
... visitCompany 0..1 string Facility group for this visit
... visitReferringDoctor C 0..1 Reference(Practitioner) Referring doctor for the visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeServiceFacility 0..1 string Service facility group for the visit
... chargeRenderingProvider C 0..1 Reference(Practitioner) Rendering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeSupervisingProvider C 0..1 Reference(Practitioner) Supervising doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeReferringProvider C 0..1 Reference(Practitioner) Referring doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name
... chargeOrderingProvider C 0..1 Reference(Practitioner) Ordering doctor for this visit.
ref-1: SHALL have a contained resource if a local reference is provided
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string DoctorId refering to Practitioner
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Practitioner Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
athena-charge-profile.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.fee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalFee.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.allowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.totalAllowed.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.coPayAmount.currencyrequiredCurrencies (a valid code from urn:iso:std:iso:4217)
http://hl7.org/fhir/ValueSet/currencies|4.0.1
from the FHIR Standard
athena-charge-profile.doctor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.visitReferringDoctor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeRenderingProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeSupervisingProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeReferringProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
athena-charge-profile.chargeOrderingProvider.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ref-1errorathena-charge-profile.patient, athena-charge-profile.doctor, athena-charge-profile.visitReferringDoctor, athena-charge-profile.chargeRenderingProvider, athena-charge-profile.chargeSupervisingProvider, athena-charge-profile.chargeReferringProvider, athena-charge-profile.chargeOrderingProviderSHALL 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'))

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)
Must-Support: 3 elements

 

Other representations of profile: CSV, Excel

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Charge resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/customresource/Charge?{search-parameters}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://ap22sandbox.athenahealth.com/demoAPIServer
_id (token) The ID of the resource
patientProfileId known id of the patient.
patient (reference) Who the sensitivity is for
[_include] Specifies the supported hl7 resources include which are defined as reference in examples. Note: The Patient and Practitioner resources are supported via the _include parameter.
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.