FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example ValueSet/event-resource-types (JSON)

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Value SetEvent Resource Types

{
  "resourceType" : "ValueSet",
  "id" : "event-resource-types",
  "meta" : {
    "lastUpdated" : "2023-01-28T16:22:47.428+00:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include these codes as defined in <a href=\"codesystem-fhir-types.html\"><code>http://hl7.org/fhir/fhir-types</code></a><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-AuditEvent\">AuditEvent</a></td><td>AuditEvent</td><td>A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-ChargeItem\">ChargeItem</a></td><td>ChargeItem</td><td>The resource ChargeItem describes the 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 ChargeItem is to enable the billing process and internal cost allocation.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-ClaimResponse\">ClaimResponse</a></td><td>ClaimResponse</td><td>This resource provides the adjudication details from the processing of a Claim resource.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-ClinicalImpression\">ClinicalImpression</a></td><td>ClinicalImpression</td><td>A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter,  but this varies greatly depending on the clinical workflow. This resource is called &quot;ClinicalImpression&quot; rather than &quot;ClinicalAssessment&quot; to avoid confusion with the recording of assessment tools such as Apgar score.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Communication\">Communication</a></td><td>Communication</td><td>A clinical or business level record of information being transmitted or shared; e.g. an alert that was sent to a responsible provider, a public health agency communication to a provider/reporter in response to a case report for a reportable condition.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Composition\">Composition</a></td><td>Composition</td><td>A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Consent\">Consent</a></td><td>Consent</td><td>A record of a healthcare consumer’s  choices  or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Coverage\">Coverage</a></td><td>Coverage</td><td>Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-CoverageEligibilityResponse\">CoverageEligibilityResponse</a></td><td>CoverageEligibilityResponse</td><td>This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-DetectedIssue\">DetectedIssue</a></td><td>DetectedIssue</td><td>Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-DeviceUsage\">DeviceUsage</a></td><td>DeviceUsage</td><td>A record of a device being used by a patient where the record is the result of a report from the patient or a clinician.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-DiagnosticReport\">DiagnosticReport</a></td><td>DiagnosticReport</td><td>The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-DocumentReference\">DocumentReference</a></td><td>DocumentReference</td><td>A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this &quot;document&quot; encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare.  The DocumentReference resource provides metadata about the document so that the document can be discovered and managed.  The actual content may be inline base64 encoded data or provided by direct reference.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Encounter\">Encounter</a></td><td>Encounter</td><td>An interaction between healthcare provider(s), and/or patient(s) for the purpose of providing healthcare service(s) or assessing the health status of patient(s).</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-EnrollmentResponse\">EnrollmentResponse</a></td><td>EnrollmentResponse</td><td>This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-EpisodeOfCare\">EpisodeOfCare</a></td><td>EpisodeOfCare</td><td>An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-ExplanationOfBenefit\">ExplanationOfBenefit</a></td><td>ExplanationOfBenefit</td><td>This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-FamilyMemberHistory\">FamilyMemberHistory</a></td><td>FamilyMemberHistory</td><td>Significant health conditions for a person related to the patient relevant in the context of care for the patient.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-GuidanceResponse\">GuidanceResponse</a></td><td>GuidanceResponse</td><td>A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-ImagingSelection\">ImagingSelection</a></td><td>ImagingSelection</td><td>A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-ImagingStudy\">ImagingStudy</a></td><td>ImagingStudy</td><td>Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context.  A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Immunization\">Immunization</a></td><td>Immunization</td><td>Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-ImmunizationEvaluation\">ImmunizationEvaluation</a></td><td>ImmunizationEvaluation</td><td>Describes a comparison of an immunization event against published recommendations to determine if the administration is &quot;valid&quot; in relation to those  recommendations.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-InventoryReport\">InventoryReport</a></td><td>InventoryReport</td><td>A report of inventory or stock items.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-MedicationAdministration\">MedicationAdministration</a></td><td>MedicationAdministration</td><td>Describes the event of a patient consuming or otherwise being administered a medication.  This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. This event can also be used to record waste using a status of not-done and the appropriate statusReason.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-MedicationDispense\">MedicationDispense</a></td><td>MedicationDispense</td><td>Indicates that a medication product is to be or has been dispensed for a named person/patient.  This includes a description of the medication product (supply) provided and the instructions for administering the medication.  The medication dispense is the result of a pharmacy system responding to a medication order.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-MedicationUsage\">MedicationUsage</a></td><td>MedicationUsage</td><td>A record of a medication that is being consumed by a patient.   A MedicationUsage may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future.  The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician.  A common scenario where this information is captured is during the history taking process during a patient visit or stay.   The medication information may come from sources such as the patient's memory, from a prescription bottle,  or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medicationusage and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication.  A medicationusage is often, if not always, less specific.  There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise.  As stated earlier, the Medication Usage information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains.  Medication administration is more formal and is not missing detailed information.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-NutritionIntake\">NutritionIntake</a></td><td>NutritionIntake</td><td>A record of food or fluid that is being consumed by a patient.  A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past.  The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician.  A common scenario where this information is captured is during the history taking process during a patient visit or stay or through an app that tracks food or fluids consumed.   The consumption information may come from sources such as the patient's memory, from a nutrition label,  or from a clinician documenting observed intake.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Observation\">Observation</a></td><td>Observation</td><td>Measurements and simple assertions made about a patient, device or other subject.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-PaymentNotice\">PaymentNotice</a></td><td>PaymentNotice</td><td>This resource provides the status of the payment for goods and services rendered, and the request and response resource references.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-PaymentReconciliation\">PaymentReconciliation</a></td><td>PaymentReconciliation</td><td>This resource provides the details including amount of a payment and allocates the payment items being paid.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Procedure\">Procedure</a></td><td>Procedure</td><td>An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy.  This can be a quality or safety inspection for a location, organization, or device.  This can be an accreditation procedure on a practitioner for licensing.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Provenance\">Provenance</a></td><td>Provenance</td><td>Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-QuestionnaireResponse\">QuestionnaireResponse</a></td><td>QuestionnaireResponse</td><td>A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-RiskAssessment\">RiskAssessment</a></td><td>RiskAssessment</td><td>An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-SupplyDelivery\">SupplyDelivery</a></td><td>SupplyDelivery</td><td>Record of delivery of what is supplied.</td></tr><tr><td><a href=\"codesystem-fhir-types.html#fhir-types-Transport\">Transport</a></td><td>Transport</td><td>Record of transport.</td></tr></table></li></ul></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/ValueSet/event-resource-types",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.1060"
  }],
  "version" : "5.0.0-cibuild",
  "name" : "EventResourceTypes",
  "title" : "Event Resource Types",
  "status" : "active",
  "experimental" : false,
  "date" : "2023-01-28T16:22:47+00:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "All Resource Types that represent event resources",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "immutable" : true,
  "compose" : {
    "include" : [{
      "system" : "http://hl7.org/fhir/fhir-types",
      "concept" : [{
        "code" : "AuditEvent"
      },
      {
        "code" : "ChargeItem"
      },
      {
        "code" : "ClaimResponse"
      },
      {
        "code" : "ClinicalImpression"
      },
      {
        "code" : "Communication"
      },
      {
        "code" : "Composition"
      },
      {
        "code" : "Consent"
      },
      {
        "code" : "Coverage"
      },
      {
        "code" : "CoverageEligibilityResponse"
      },
      {
        "code" : "DetectedIssue"
      },
      {
        "code" : "DeviceUsage"
      },
      {
        "code" : "DiagnosticReport"
      },
      {
        "code" : "DocumentReference"
      },
      {
        "code" : "Encounter"
      },
      {
        "code" : "EnrollmentResponse"
      },
      {
        "code" : "EpisodeOfCare"
      },
      {
        "code" : "ExplanationOfBenefit"
      },
      {
        "code" : "FamilyMemberHistory"
      },
      {
        "code" : "GuidanceResponse"
      },
      {
        "code" : "ImagingSelection"
      },
      {
        "code" : "ImagingStudy"
      },
      {
        "code" : "Immunization"
      },
      {
        "code" : "ImmunizationEvaluation"
      },
      {
        "code" : "InventoryReport"
      },
      {
        "code" : "MedicationAdministration"
      },
      {
        "code" : "MedicationDispense"
      },
      {
        "code" : "MedicationUsage"
      },
      {
        "code" : "NutritionIntake"
      },
      {
        "code" : "Observation"
      },
      {
        "code" : "PaymentNotice"
      },
      {
        "code" : "PaymentReconciliation"
      },
      {
        "code" : "Procedure"
      },
      {
        "code" : "Provenance"
      },
      {
        "code" : "QuestionnaireResponse"
      },
      {
        "code" : "RiskAssessment"
      },
      {
        "code" : "SupplyDelivery"
      },
      {
        "code" : "Transport"
      }]
    }]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.