This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
This resource maintained by the Financial Management Work Group
A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
The PharmacyClaim is one of a suite of similar resources (OralHealthClaim, VisionClaim, PharmacyClaim, ProfessionalClaim, InstitutionalClaim) which are used by providers to exchange the financial information, and supporting clinical information, regarding the provision of healthcare services. The primary uses of this resource is to support eClaims, the exchange of proposed or actual services to benefit payors, insurers and national health programs, for treatment payment planning and reimbursement.
The Claim is intended to support:
The Claim also supports:
Todo
This resource is referenced by ClaimResponse and Reversal
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PharmacyClaim | DomainResource | Claim, Pre-determination or Pre-authorization | ||
identifier | 0..* | Identifier | Claim number | |
ruleset | 0..1 | Coding | Current specification followed Ruleset (Example) | |
originalRuleset | 0..1 | Coding | Original specification followed Ruleset (Example) | |
created | 0..1 | dateTime | Creation date | |
target | 0..1 | Organization | Insurer | |
provider | 0..1 | Practitioner | Responsible provider | |
organization | 0..1 | Organization | Responsible organization | |
use | 0..1 | code | complete | proposed | exploratory | other Use (Required) | |
priority | 0..1 | Coding | Desired processing priority ProcessPriority (Example) | |
fundsReserve | 0..1 | Coding | Funds requested to be reserved FundsReserve (Example) | |
enterer | 0..1 | Practitioner | Author | |
facility | 0..1 | Location | Servicing Facility | |
prescription | 0..1 | MedicationPrescription | Current Prescription | |
originalPrescription | 0..1 | MedicationPrescription | Original Prescription | |
payee | 0..1 | Element | Payee | |
type | 0..1 | Coding | Party to be paid any benefits payable PayeeType (Example) | |
provider | 0..1 | Practitioner | Provider who is the payee | |
organization | 0..1 | Organization | Organization who is the payee | |
person | 0..1 | Patient | Other person who is the payee | |
referral | 0..1 | ReferralRequest | Treatment Referral | |
diagnosis | 0..* | Element | Diagnosis | |
sequence | 1..1 | integer | Sequence of diagnosis | |
diagnosis | 1..1 | Coding | Patient's list of diagnosis ICD10 (Example) | |
condition | 0..* | Coding | List of presenting Conditions Conditions (Example) | |
patient | 1..1 | Patient | The subject of the Products and Services | |
coverage | 0..* | Element | Insurance or medical plan | |
sequence | 1..1 | integer | Service instance identifier | |
focal | 1..1 | boolean | Is the focal Coverage | |
coverage | 1..1 | Coverage | Insurance information | |
businessArrangement | 0..1 | string | Business agreement | |
relationship | 1..1 | Coding | Patient relationship to subscriber Relationship (Example) | |
preauthref | 0..* | string | Pre-Authorization/Determination Reference | |
claimResponse | 0..1 | ClaimResponse | Adjudication results | |
originalRuleset | 0..1 | Coding | Original version Ruleset (Example) | |
exception | 0..* | Coding | Eligibility exceptions Exception (Example) | |
school | 0..1 | string | Name of School | |
accident | 0..1 | date | Accident Date | |
accidentType | 0..1 | Coding | Accident Type AccidentType (Example) | |
interventionException | 0..* | Coding | Intervention and exception code (Pharma) Intervention (Example) | |
item | 0..* | Element | Goods and Services | |
sequence | 1..1 | integer | Service instance | |
type | 1..1 | Coding | Group or type of product or service ItemType (Example) | |
provider | 0..1 | Practitioner | Responsible practitioner | |
diagnosisLinkId | 0..* | integer | Diagnosis Link | |
service | 1..1 | Coding | Item Code PharmacyServiceProduct (Example) | |
serviceDate | 0..1 | date | Date of Service | |
quantity | 0..1 | Quantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total item cost | |
udi | 0..1 | Coding | Unique Device Identifier UDI (Example) | |
bodySite | 0..1 | Coding | Service Location ICD10 (Example) | |
subsite | 0..* | Coding | Service Sub-location ICD10 (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifiers (Example) | |
detail | 0..* | Element | Additional items | |
sequence | 1..1 | integer | Service instance | |
type | 1..1 | Coding | Group or type of product or service ItemType (Example) | |
service | 1..1 | Coding | Additional item codes PharmacyServiceProduct (Example) | |
quantity | 0..1 | Quantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total additional item cost | |
udi | 0..1 | Coding | Unique Device Identifier UDI (Example) | |
subDetail | 0..* | Element | Additional items | |
sequence | 1..1 | integer | Service instance | |
type | 1..1 | Coding | Type of product or service ItemType (Example) | |
service | 1..1 | Coding | Additional item codes PharmacyServiceProduct (Example) | |
quantity | 0..1 | Quantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Net additional item cost | |
udi | 0..1 | Coding | Unique Device Identifier UDI (Example) | |
additionalMaterials | 0..* | Coding | Additional materials, documents, etc. AdditionalMaterials (Example) |
UML Diagram
XML Template
<PharmacyClaim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Claim number --></identifier> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <target><!-- 0..1 Reference(Organization) Insurer --></target> <provider><!-- 0..1 Reference(Practitioner) Responsible provider --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <priority><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve> <enterer><!-- 0..1 Reference(Practitioner) Author --></enterer> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <prescription><!-- 0..1 Reference(MedicationPrescription) Current Prescription --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationPrescription) Original Prescription --></originalPrescription> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Party to be paid any benefits payable --></type> <provider><!-- 0..1 Reference(Practitioner) Provider who is the payee --></provider> <organization><!-- 0..1 Reference(Organization) Organization who is the payee --></organization> <person><!-- 0..1 Reference(Patient) Other person who is the payee --></person> </payee> <referral><!-- 0..1 Reference(ReferralRequest) Treatment Referral --></referral> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[integer]"/><!-- 1..1 Sequence of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis> <condition><!-- 0..* Coding List of presenting Conditions --></condition> <patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[integer]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship> <preauthref value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage> <exception><!-- 0..* Coding Eligibility exceptions --></exception> <school value="[string]"/><!-- 0..1 Name of School --> <accident value="[date]"/><!-- 0..1 Accident Date --> <accidentType><!-- 0..1 Coding Accident Type --></accidentType> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <item> <!-- 0..* Goods and Services --> <sequence value="[integer]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <diagnosisLinkId value="[integer]"/><!-- 0..* Diagnosis Link --> <service><!-- 1..1 Coding Item Code --></service> <serviceDate value="[date]"/><!-- 0..1 Date of Service --> <quantity><!-- 0..1 Quantity Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subsite><!-- 0..* Coding Service Sub-location --></subsite> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <detail> <!-- 0..* Additional items --> <sequence value="[integer]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[integer]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Net additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> </subDetail> </detail> </item> <additionalMaterials><!-- 0..* Coding Additional materials, documents, etc. --></additionalMaterials> </PharmacyClaim>
JSON Template
{ "resourceType" : "PharmacyClaim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Claim number "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "target" : { Reference(Organization) }, // Insurer "provider" : { Reference(Practitioner) }, // Responsible provider "organization" : { Reference(Organization) }, // Responsible organization "use" : "<code>", // complete | proposed | exploratory | other "priority" : { Coding }, // Desired processing priority "fundsReserve" : { Coding }, // Funds requested to be reserved "enterer" : { Reference(Practitioner) }, // Author "facility" : { Reference(Location) }, // Servicing Facility "prescription" : { Reference(MedicationPrescription) }, // Current Prescription "originalPrescription" : { Reference(MedicationPrescription) }, // Original Prescription "payee" : { // Payee "type" : { Coding }, // Party to be paid any benefits payable "provider" : { Reference(Practitioner) }, // Provider who is the payee "organization" : { Reference(Organization) }, // Organization who is the payee "person" : { Reference(Patient) } // Other person who is the payee }, "referral" : { Reference(ReferralRequest) }, // Treatment Referral "diagnosis" : [{ // Diagnosis "sequence" : <integer>, // R! Sequence of diagnosis "diagnosis" : { Coding } // R! Patient's list of diagnosis }], "condition" : [{ Coding }], // List of presenting Conditions "patient" : { Reference(Patient) }, // R! The subject of the Products and Services "coverage" : [{ // Insurance or medical plan "sequence" : <integer>, // R! Service instance identifier "focal" : <boolean>, // R! Is the focal Coverage "coverage" : { Reference(Coverage) }, // R! Insurance information "businessArrangement" : "<string>", // Business agreement "relationship" : { Coding }, // R! Patient relationship to subscriber "preauthref" : ["<string>"], // Pre-Authorization/Determination Reference "claimResponse" : { Reference(ClaimResponse) }, // Adjudication results "originalRuleset" : { Coding } // Original version }], "exception" : [{ Coding }], // Eligibility exceptions "school" : "<string>", // Name of School "accident" : "<date>", // Accident Date "accidentType" : { Coding }, // Accident Type "interventionException" : [{ Coding }], // Intervention and exception code (Pharma) "item" : [{ // Goods and Services "sequence" : <integer>, // R! Service instance "type" : { Coding }, // R! Group or type of product or service "provider" : { Reference(Practitioner) }, // Responsible practitioner "diagnosisLinkId" : [<integer>], // Diagnosis Link "service" : { Coding }, // R! Item Code "serviceDate" : "<date>", // Date of Service "quantity" : { Quantity }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total item cost "udi" : { Coding }, // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subsite" : [{ Coding }], // Service Sub-location "modifier" : [{ Coding }], // Service/Product billing modifiers "detail" : [{ // Additional items "sequence" : <integer>, // R! Service instance "type" : { Coding }, // R! Group or type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total additional item cost "udi" : { Coding }, // Unique Device Identifier "subDetail" : [{ // Additional items "sequence" : <integer>, // R! Service instance "type" : { Coding }, // R! Type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Net additional item cost "udi" : { Coding } // Unique Device Identifier }] }] }], "additionalMaterials" : [{ Coding }] // Additional materials, documents, etc. }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PharmacyClaim | DomainResource | Claim, Pre-determination or Pre-authorization | ||
identifier | 0..* | Identifier | Claim number | |
ruleset | 0..1 | Coding | Current specification followed Ruleset (Example) | |
originalRuleset | 0..1 | Coding | Original specification followed Ruleset (Example) | |
created | 0..1 | dateTime | Creation date | |
target | 0..1 | Organization | Insurer | |
provider | 0..1 | Practitioner | Responsible provider | |
organization | 0..1 | Organization | Responsible organization | |
use | 0..1 | code | complete | proposed | exploratory | other Use (Required) | |
priority | 0..1 | Coding | Desired processing priority ProcessPriority (Example) | |
fundsReserve | 0..1 | Coding | Funds requested to be reserved FundsReserve (Example) | |
enterer | 0..1 | Practitioner | Author | |
facility | 0..1 | Location | Servicing Facility | |
prescription | 0..1 | MedicationPrescription | Current Prescription | |
originalPrescription | 0..1 | MedicationPrescription | Original Prescription | |
payee | 0..1 | Element | Payee | |
type | 0..1 | Coding | Party to be paid any benefits payable PayeeType (Example) | |
provider | 0..1 | Practitioner | Provider who is the payee | |
organization | 0..1 | Organization | Organization who is the payee | |
person | 0..1 | Patient | Other person who is the payee | |
referral | 0..1 | ReferralRequest | Treatment Referral | |
diagnosis | 0..* | Element | Diagnosis | |
sequence | 1..1 | integer | Sequence of diagnosis | |
diagnosis | 1..1 | Coding | Patient's list of diagnosis ICD10 (Example) | |
condition | 0..* | Coding | List of presenting Conditions Conditions (Example) | |
patient | 1..1 | Patient | The subject of the Products and Services | |
coverage | 0..* | Element | Insurance or medical plan | |
sequence | 1..1 | integer | Service instance identifier | |
focal | 1..1 | boolean | Is the focal Coverage | |
coverage | 1..1 | Coverage | Insurance information | |
businessArrangement | 0..1 | string | Business agreement | |
relationship | 1..1 | Coding | Patient relationship to subscriber Relationship (Example) | |
preauthref | 0..* | string | Pre-Authorization/Determination Reference | |
claimResponse | 0..1 | ClaimResponse | Adjudication results | |
originalRuleset | 0..1 | Coding | Original version Ruleset (Example) | |
exception | 0..* | Coding | Eligibility exceptions Exception (Example) | |
school | 0..1 | string | Name of School | |
accident | 0..1 | date | Accident Date | |
accidentType | 0..1 | Coding | Accident Type AccidentType (Example) | |
interventionException | 0..* | Coding | Intervention and exception code (Pharma) Intervention (Example) | |
item | 0..* | Element | Goods and Services | |
sequence | 1..1 | integer | Service instance | |
type | 1..1 | Coding | Group or type of product or service ItemType (Example) | |
provider | 0..1 | Practitioner | Responsible practitioner | |
diagnosisLinkId | 0..* | integer | Diagnosis Link | |
service | 1..1 | Coding | Item Code PharmacyServiceProduct (Example) | |
serviceDate | 0..1 | date | Date of Service | |
quantity | 0..1 | Quantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total item cost | |
udi | 0..1 | Coding | Unique Device Identifier UDI (Example) | |
bodySite | 0..1 | Coding | Service Location ICD10 (Example) | |
subsite | 0..* | Coding | Service Sub-location ICD10 (Example) | |
modifier | 0..* | Coding | Service/Product billing modifiers Modifiers (Example) | |
detail | 0..* | Element | Additional items | |
sequence | 1..1 | integer | Service instance | |
type | 1..1 | Coding | Group or type of product or service ItemType (Example) | |
service | 1..1 | Coding | Additional item codes PharmacyServiceProduct (Example) | |
quantity | 0..1 | Quantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Total additional item cost | |
udi | 0..1 | Coding | Unique Device Identifier UDI (Example) | |
subDetail | 0..* | Element | Additional items | |
sequence | 1..1 | integer | Service instance | |
type | 1..1 | Coding | Type of product or service ItemType (Example) | |
service | 1..1 | Coding | Additional item codes PharmacyServiceProduct (Example) | |
quantity | 0..1 | Quantity | Count of Products or Services | |
unitPrice | 0..1 | Money | Fee, charge or cost per point | |
factor | 0..1 | decimal | Price scaling factor | |
points | 0..1 | decimal | Difficulty scaling factor | |
net | 0..1 | Money | Net additional item cost | |
udi | 0..1 | Coding | Unique Device Identifier UDI (Example) | |
additionalMaterials | 0..* | Coding | Additional materials, documents, etc. AdditionalMaterials (Example) |
XML Template
<PharmacyClaim xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Claim number --></identifier> <ruleset><!-- 0..1 Coding Current specification followed --></ruleset> <originalRuleset><!-- 0..1 Coding Original specification followed --></originalRuleset> <created value="[dateTime]"/><!-- 0..1 Creation date --> <target><!-- 0..1 Reference(Organization) Insurer --></target> <provider><!-- 0..1 Reference(Practitioner) Responsible provider --></provider> <organization><!-- 0..1 Reference(Organization) Responsible organization --></organization> <use value="[code]"/><!-- 0..1 complete | proposed | exploratory | other --> <priority><!-- 0..1 Coding Desired processing priority --></priority> <fundsReserve><!-- 0..1 Coding Funds requested to be reserved --></fundsReserve> <enterer><!-- 0..1 Reference(Practitioner) Author --></enterer> <facility><!-- 0..1 Reference(Location) Servicing Facility --></facility> <prescription><!-- 0..1 Reference(MedicationPrescription) Current Prescription --></prescription> <originalPrescription><!-- 0..1 Reference(MedicationPrescription) Original Prescription --></originalPrescription> <payee> <!-- 0..1 Payee --> <type><!-- 0..1 Coding Party to be paid any benefits payable --></type> <provider><!-- 0..1 Reference(Practitioner) Provider who is the payee --></provider> <organization><!-- 0..1 Reference(Organization) Organization who is the payee --></organization> <person><!-- 0..1 Reference(Patient) Other person who is the payee --></person> </payee> <referral><!-- 0..1 Reference(ReferralRequest) Treatment Referral --></referral> <diagnosis> <!-- 0..* Diagnosis --> <sequence value="[integer]"/><!-- 1..1 Sequence of diagnosis --> <diagnosis><!-- 1..1 Coding Patient's list of diagnosis --></diagnosis> </diagnosis> <condition><!-- 0..* Coding List of presenting Conditions --></condition> <patient><!-- 1..1 Reference(Patient) The subject of the Products and Services --></patient> <coverage> <!-- 0..* Insurance or medical plan --> <sequence value="[integer]"/><!-- 1..1 Service instance identifier --> <focal value="[boolean]"/><!-- 1..1 Is the focal Coverage --> <coverage><!-- 1..1 Reference(Coverage) Insurance information --></coverage> <businessArrangement value="[string]"/><!-- 0..1 Business agreement --> <relationship><!-- 1..1 Coding Patient relationship to subscriber --></relationship> <preauthref value="[string]"/><!-- 0..* Pre-Authorization/Determination Reference --> <claimResponse><!-- 0..1 Reference(ClaimResponse) Adjudication results --></claimResponse> <originalRuleset><!-- 0..1 Coding Original version --></originalRuleset> </coverage> <exception><!-- 0..* Coding Eligibility exceptions --></exception> <school value="[string]"/><!-- 0..1 Name of School --> <accident value="[date]"/><!-- 0..1 Accident Date --> <accidentType><!-- 0..1 Coding Accident Type --></accidentType> <interventionException><!-- 0..* Coding Intervention and exception code (Pharma) --></interventionException> <item> <!-- 0..* Goods and Services --> <sequence value="[integer]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <provider><!-- 0..1 Reference(Practitioner) Responsible practitioner --></provider> <diagnosisLinkId value="[integer]"/><!-- 0..* Diagnosis Link --> <service><!-- 1..1 Coding Item Code --></service> <serviceDate value="[date]"/><!-- 0..1 Date of Service --> <quantity><!-- 0..1 Quantity Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <bodySite><!-- 0..1 Coding Service Location --></bodySite> <subsite><!-- 0..* Coding Service Sub-location --></subsite> <modifier><!-- 0..* Coding Service/Product billing modifiers --></modifier> <detail> <!-- 0..* Additional items --> <sequence value="[integer]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Group or type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Total additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> <subDetail> <!-- 0..* Additional items --> <sequence value="[integer]"/><!-- 1..1 Service instance --> <type><!-- 1..1 Coding Type of product or service --></type> <service><!-- 1..1 Coding Additional item codes --></service> <quantity><!-- 0..1 Quantity Count of Products or Services --></quantity> <unitPrice><!-- 0..1 Money Fee, charge or cost per point --></unitPrice> <factor value="[decimal]"/><!-- 0..1 Price scaling factor --> <points value="[decimal]"/><!-- 0..1 Difficulty scaling factor --> <net><!-- 0..1 Money Net additional item cost --></net> <udi><!-- 0..1 Coding Unique Device Identifier --></udi> </subDetail> </detail> </item> <additionalMaterials><!-- 0..* Coding Additional materials, documents, etc. --></additionalMaterials> </PharmacyClaim>
JSON Template
{ "resourceType" : "PharmacyClaim", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Claim number "ruleset" : { Coding }, // Current specification followed "originalRuleset" : { Coding }, // Original specification followed "created" : "<dateTime>", // Creation date "target" : { Reference(Organization) }, // Insurer "provider" : { Reference(Practitioner) }, // Responsible provider "organization" : { Reference(Organization) }, // Responsible organization "use" : "<code>", // complete | proposed | exploratory | other "priority" : { Coding }, // Desired processing priority "fundsReserve" : { Coding }, // Funds requested to be reserved "enterer" : { Reference(Practitioner) }, // Author "facility" : { Reference(Location) }, // Servicing Facility "prescription" : { Reference(MedicationPrescription) }, // Current Prescription "originalPrescription" : { Reference(MedicationPrescription) }, // Original Prescription "payee" : { // Payee "type" : { Coding }, // Party to be paid any benefits payable "provider" : { Reference(Practitioner) }, // Provider who is the payee "organization" : { Reference(Organization) }, // Organization who is the payee "person" : { Reference(Patient) } // Other person who is the payee }, "referral" : { Reference(ReferralRequest) }, // Treatment Referral "diagnosis" : [{ // Diagnosis "sequence" : <integer>, // R! Sequence of diagnosis "diagnosis" : { Coding } // R! Patient's list of diagnosis }], "condition" : [{ Coding }], // List of presenting Conditions "patient" : { Reference(Patient) }, // R! The subject of the Products and Services "coverage" : [{ // Insurance or medical plan "sequence" : <integer>, // R! Service instance identifier "focal" : <boolean>, // R! Is the focal Coverage "coverage" : { Reference(Coverage) }, // R! Insurance information "businessArrangement" : "<string>", // Business agreement "relationship" : { Coding }, // R! Patient relationship to subscriber "preauthref" : ["<string>"], // Pre-Authorization/Determination Reference "claimResponse" : { Reference(ClaimResponse) }, // Adjudication results "originalRuleset" : { Coding } // Original version }], "exception" : [{ Coding }], // Eligibility exceptions "school" : "<string>", // Name of School "accident" : "<date>", // Accident Date "accidentType" : { Coding }, // Accident Type "interventionException" : [{ Coding }], // Intervention and exception code (Pharma) "item" : [{ // Goods and Services "sequence" : <integer>, // R! Service instance "type" : { Coding }, // R! Group or type of product or service "provider" : { Reference(Practitioner) }, // Responsible practitioner "diagnosisLinkId" : [<integer>], // Diagnosis Link "service" : { Coding }, // R! Item Code "serviceDate" : "<date>", // Date of Service "quantity" : { Quantity }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total item cost "udi" : { Coding }, // Unique Device Identifier "bodySite" : { Coding }, // Service Location "subsite" : [{ Coding }], // Service Sub-location "modifier" : [{ Coding }], // Service/Product billing modifiers "detail" : [{ // Additional items "sequence" : <integer>, // R! Service instance "type" : { Coding }, // R! Group or type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Total additional item cost "udi" : { Coding }, // Unique Device Identifier "subDetail" : [{ // Additional items "sequence" : <integer>, // R! Service instance "type" : { Coding }, // R! Type of product or service "service" : { Coding }, // R! Additional item codes "quantity" : { Quantity }, // Count of Products or Services "unitPrice" : { Money }, // Fee, charge or cost per point "factor" : <decimal>, // Price scaling factor "points" : <decimal>, // Difficulty scaling factor "net" : { Money }, // Net additional item cost "udi" : { Coding } // Unique Device Identifier }] }] }], "additionalMaterials" : [{ Coding }] // Additional materials, documents, etc. }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
PharmacyClaim.ruleset PharmacyClaim.originalRuleset PharmacyClaim.coverage.originalRuleset | The static and dynamic model to which contents conform, may be business version or standard and version. | Example | http://hl7.org/fhir/vs/ruleset |
PharmacyClaim.use | Complete, proposed, exploratory, other | Fixed | http://hl7.org/fhir/use-link |
PharmacyClaim.priority | The timeliness with which processing is required: STAT, normal, Deferred | Example | http://hl7.org/fhir/vs/process-priority |
PharmacyClaim.fundsReserve | For whom funds are to be reserved: (Patient, Provider, None) | Example | http://hl7.org/fhir/vs/fundsreserve |
PharmacyClaim.payee.type | A code for the party to be reimbursed. | Example | http://hl7.org/fhir/vs/payeetype |
PharmacyClaim.diagnosis.diagnosis PharmacyClaim.item.bodySite PharmacyClaim.item.subsite | ICD10 Diagnostic codes | Example | http://hl7.org/fhir/vs/icd-10 |
PharmacyClaim.condition | Patient conditions and symptoms | Example | http://hl7.org/fhir/vs/fm-conditions |
PharmacyClaim.coverage.relationship | The code for the relationship of the patient to the subscriber | Example | http://hl7.org/fhir/vs/relationship |
PharmacyClaim.exception | The eligibility exception codes. | Example | http://hl7.org/fhir/vs/exception |
PharmacyClaim.accidentType | Type of accident: work place, auto, etc. | Example | http://hl7.org/fhir/vs/ActIncidentCode |
PharmacyClaim.interventionException | Intervention and exception codes (Pharm) | Example | http://hl7.org/fhir/vs/intervention |
PharmacyClaim.item.type PharmacyClaim.item.detail.type PharmacyClaim.item.detail.subDetail.type | Service, Product, Rx Dispense, Rx Compound etc. | Example | http://hl7.org/fhir/vs/ActInvoiceGroupCode |
PharmacyClaim.item.service PharmacyClaim.item.detail.service PharmacyClaim.item.detail.subDetail.service | Allowable service and product codes | Example | http://hl7.org/fhir/vs/service-pharmacy |
PharmacyClaim.item.udi PharmacyClaim.item.detail.udi PharmacyClaim.item.detail.subDetail.udi | The FDA, or other, UDI repository. | Example | http://hl7.org/fhir/vs/udi |
PharmacyClaim.item.modifier | Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen. | Example | http://hl7.org/fhir/vs/modifiers |
PharmacyClaim.additionalMaterials | Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission. | Example | http://hl7.org/fhir/vs/additionalmaterials |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
identifier | token | The primary identifier of the financial resource | PharmacyClaim.identifier |
patient | reference | Patient | PharmacyClaim.patient (Patient) |
priority | token | Processing priority requested | PharmacyClaim.priority |
use | token | The kind of financial resource | PharmacyClaim.use |