ChargeItem - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
accounttrueReference Account to place this charge
bodysitetrueCodeableConcept Anatomical location, if relevant
codefalseCodeableConcept A code that identifies the charge, like a billing code
contextfalseReference Encounter / Episode associated with event
definitiontrueuri Defining information about the code of this charge item
enteredDatefalsedateTime Date the charge item was entered
entererfalseReference "enterer" : { Reference(Practitioner|Organization|Patient|Device|
factorOverridefalsedecimal Factor overriding the associated rules
identifierfalseIdentifier Business Identifier for item
notetrueAnnotation Comments made about the ChargeItem
occurrenceDateTimefalsedateTime "occurrenceDateTime" : "<dateTime>",
occurrencePeriodfalsePeriod "occurrencePeriod" : { Period },
occurrenceTimingfalseTiming "occurrenceTiming" : { Timing },
overrideReasonfalsestring Reason for overriding the list price/factor
partOftrueReference Part of referenced ChargeItem
participanttrueData Type Who performed charged service
performingOrganizationfalseReference Organization providing the charged sevice
priceOverridefalseMoney Price overriding the associated rules
quantityfalseQuantity Quantity of which the charge item has been serviced
reasontrueCodeableConcept Why was the charged service rendered?
requestingOrganizationfalseReference Organization requesting the charged service
servicetrueReference "service" : [{ Reference(DiagnosticReport|ImagingStudy|Immunization|
statusfalsecode planned | billable | not-billable | aborted | billed | entered-in-error | unknown
subjectfalseReference Individual service was done for/to
supportingInformationtrueReference Further information supporting the this charge

ChargeItem Example

{
  "code": {
    "coding": [
      {
        "code": "01510",
        "display": "Zusatzpauschale für Beobachtung nach diagnostischer Koronarangiografie"
      }
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Example of ChargeItem Usage in Context of the German EBM Billing code system</div>"
  },
  "priceOverride": {
    "code": "EUR",
    "unit": "EUR",
    "value": 40,
    "system": "urn:iso:std:iso:4217"
  },
  "id": "example",
  "subject": {
    "reference": "Patient/example"
  },
  "participant": [
    {
      "role": {
        "coding": [
          {
            "code": "17561000",
            "system": "http://snomed.info/sct",
            "display": "Cardiologist"
          }
        ]
      },
      "actor": {
        "reference": "Practitioner/example"
      }
    },
    {
      "role": {
        "coding": [
          {
            "code": "224542009",
            "system": "http://snomed.info/sct",
            "display": "Coronary Care Nurse"
          }
        ]
      },
      "actor": {
        "reference": "Practitioner/example"
      }
    }
  ],
  "requestingOrganization": {
    "identifier": {
      "system": "http://myhospital/NamingSystem/departments",
      "value": "CARD_U1"
    }
  },
  "enterer": {
    "reference": "Practitioner/example"
  },
  "note": [
    {
      "text": "The code is only applicable for periods longer than 4h",
      "time": "2017-01-25T23:55:04+01:00",
      "authorReference": {
        "reference": "Practitioner/example"
      }
    }
  ],
  "occurrencePeriod": {
    "start": "2017-01-25T08:00:00+01:00",
    "end": "2017-01-25T12:35:00+01:00"
  },
  "status": "billable",
  "performingOrganization": {
    "identifier": {
      "system": "http://myhospital/NamingSystem/departments",
      "value": "CARD_INTERMEDIATE_CARE"
    }
  },
  "reason": [
    {
      "coding": [
        {
          "code": "123456",
          "system": "http://hl7.org/fhir/sid/icd-10",
          "display": "DIAG-1"
        }
      ]
    }
  ],
  "definition": [
    "http://www.kbv.de/tools/ebm/html/01520_2904360860826220813632.html"
  ],
  "account": [
    {
      "reference": "Account/example"
    }
  ],
  "service": [
    {
      "reference": "Procedure/example"
    }
  ],
  "factorOverride": 0.8,
  "resourceType": "ChargeItem",
  "overrideReason": "Patient is Cardiologist's golf buddy, so he gets a 20% discount!",
  "context": {
    "reference": "Encounter/example"
  },
  "enteredDate": "2017-01-25T23:55:04+01:00",
  "identifier": {
    "system": "http://myHospital.org/ChargeItems",
    "value": "654321"
  },
  "quantity": {
    "value": 1
  }
}

ChargeItem Structure


  
{
  "resourceType" : "ChargeItem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // Business Identifier for item
  "definition" : ["<uri>"], // Defining information about the code of this charge item
  "status" : "<code>", // R!  planned | billable | not-billable | aborted | billed | entered-in-error | unknown
  "partOf" : [{ Reference(ChargeItem) }], // Part of referenced ChargeItem
  "code" : { CodeableConcept }, // R!  A code that identifies the charge, like a billing code
  "subject" : { Reference(Patient|Group) }, // R!  Individual service was done for/to
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Encounter / Episode associated with event
  // occurrence[x]: When the charged service was applied. One of these 3:
  "occurrenceDateTime" : "<dateTime>",
  "occurrencePeriod" : { Period },
  "occurrenceTiming" : { Timing },
  "participant" : [{ // Who performed charged service
    "role" : { CodeableConcept }, // What type of performance was done
    "actor" : { Reference(Practitioner|Organization|Patient|Device|
    RelatedPerson) } // R!  Individual who was performing
  }],
  "performingOrganization" : { Reference(Organization) }, // Organization providing the charged sevice
  "requestingOrganization" : { Reference(Organization) }, // Organization requesting the charged service
  "quantity" : { Quantity }, // Quantity of which the charge item has been serviced
  "bodysite" : [{ CodeableConcept }], // Anatomical location, if relevant
  "factorOverride" : <decimal>, // Factor overriding the associated rules
  "priceOverride" : { Money }, // Price overriding the associated rules
  "overrideReason" : "<string>", // Reason for overriding the list price/factor
  "enterer" : { Reference(Practitioner|Organization|Patient|Device|
   RelatedPerson) }, // Individual who was entering
  "enteredDate" : "<dateTime>", // Date the charge item was entered
  "reason" : [{ CodeableConcept }], // Why was the charged  service rendered?
  "service" : [{ Reference(DiagnosticReport|ImagingStudy|Immunization|
   MedicationAdministration|MedicationDispense|Observation|Procedure|
   SupplyDelivery) }], // Which rendered service is being charged?
  "account" : [{ Reference(Account) }], // Account to place this charge
  "note" : [{ Annotation }], // Comments made about the ChargeItem
  "supportingInformation" : [{ Reference(Any) }] // Further information supporting the this charge
}


 

ChargeItem Search Parameters

The following search parameters can be used to query ChargeItem resources. Just submit the like so:

https://api.1up.health/fhir/stu3/ChargeItem?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
accountreferenceaccount
codetextcode
contextreferencecontext
entered-datedateenteredDate
entererreferenceenterer
factor-overridenumberfactorOverride
identifiertextidentifier
occurrencedateoccurrence
participant-actorreferenceparticipant.actor
participant-roletextparticipant.role
patientreferencesubject
performing-organizationreferenceperformingOrganization
price-overridequantitypriceOverride
quantityquantityquantity
requesting-organizationreferencerequestingOrganization
servicereferenceservice
subjectreferencesubject