The CQL Testing framework supports all FHIR DSTU2 resource types. It provides this support by dynamically referencing the formal FHIR definitions of each resource, ensuring that specified fields in the YAML file are valid fields for that resource.
The CQL Testing Framework attempts to automatically set the appropriate patient reference on data instances (based on the resource type). This means that the test author does not need to manually set the patient reference unless they wish to override the default.
In addition, the CQL Testing Framework will set default values for certain fields
when the author does not provide a value. Determining what the default value should be
is a subjective exercise, but the CQL Testing Framework team has tried to assign default
values that makes sense in most cases. In cases where an author does not want the
default value they can override it with another value or with null in cases where
they want no value at all.
Last, in a few cases, the CQL Testing Framework allows test authors to use an alias
field name. This is mainly useful for simplifying the data (e.g., allowing for code
rather than medicationCodeableConcept).
This documentation clearly indicates what the default patient reference field is, what fields will be set with default values, and what aliases are allowed.
The following list contains commonly used resource types for testing CQL-based CDS:
AllergyIntolerance | CarePlan | Condition | Device | DiagnosticReport | Encounter | FamilyMemberHistory | Goal | Immunization | Medication | MedicationAdministration | MedicationOrder | MedicationStatement | Observation | Patient | Procedure
The following list contains all FHIR DSTU2 types:
Account | AllergyIntolerance | Appointment | AppointmentResponse | AuditEvent | Basic | Binary | BodySite | Bundle | CarePlan | Claim | ClaimResponse | ClinicalImpression | Communication | CommunicationRequest | Composition | ConceptMap | Condition | Conformance | Contract | Coverage | DataElement | DetectedIssue | Device | DeviceComponent | DeviceMetric | DeviceUseRequest | DeviceUseStatement | DiagnosticOrder | DiagnosticReport | DocumentManifest | DocumentReference | DomainResource | EligibilityRequest | EligibilityResponse | Encounter | EnrollmentRequest | EnrollmentResponse | EpisodeOfCare | ExplanationOfBenefit | FamilyMemberHistory | Flag | Goal | Group | HealthcareService | ImagingObjectSelection | ImagingStudy | Immunization | ImmunizationRecommendation | ImplementationGuide | List | Location | Media | Medication | MedicationAdministration | MedicationDispense | MedicationOrder | MedicationStatement | MessageHeader | NamingSystem | NutritionOrder | Observation | OperationDefinition | OperationOutcome | Order | OrderResponse | Organization | Parameters | Patient | PaymentNotice | PaymentReconciliation | Person | Practitioner | Procedure | ProcedureRequest | ProcessRequest | ProcessResponse | Provenance | Questionnaire | QuestionnaireResponse | ReferralRequest | RelatedPerson | Resource | RiskAssessment | Schedule | SearchParameter | Slot | Specimen | StructureDefinition | Subscription | Substance | SupplyDelivery | SupplyRequest | TestScript | ValueSet | VisionPrescription
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centres, etc.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Identifies the patient, device, practitioner, location or other object the account is associated with. |
| Default Value | status | Indicates whether the account is presently used/useable or not. Default: active |
See the Account FHIR Documentation for the full list of available fields, definitions, and allowable values.
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient who has the allergy or intolerance. |
| Default Value | status | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance. Default: confirmed |
See the AllergyIntolerance FHIR Documentation for the full list of available fields, definitions, and allowable values.
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
| Field | Description | |
|---|---|---|
| Default Value | status | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. Default: booked |
See the Appointment FHIR Documentation for the full list of available fields, definitions, and allowable values.
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
| Field | Description | |
|---|---|---|
| Patient Reference | actor | A Person, Location/HealthcareService or Device that is participating in the appointment. |
| Default Value | participantStatus | Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty. Default: accepted |
See the AppointmentResponse FHIR Documentation for the full list of available fields, definitions, and allowable values.
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
See the AuditEvent FHIR Documentation for the full list of available fields, definitions, and allowable values.
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource. |
See the Basic FHIR Documentation for the full list of available fields, definitions, and allowable values.
A binary resource can contain any content, whether text, image, pdf, zip archive, etc.
See the Binary FHIR Documentation for the full list of available fields, definitions, and allowable values.
Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The person to which the body site belongs. |
See the BodySite FHIR Documentation for the full list of available fields, definitions, and allowable values.
A container for a collection of resources.
See the Bundle FHIR Documentation for the full list of available fields, definitions, and allowable values.
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Identifies the patient or group whose intended care is described by the plan. |
| Default Value | status | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Default: active |
See the CarePlan FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | Patient Resource. |
| Default Value | use | Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination). Default: complete |
See the Claim FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides the adjudication details from the processing of a Claim resource.
| Field | Description | |
|---|---|---|
| Default Value | outcome | Transaction status: error, complete. Default: complete |
See the ClaimResponse FHIR Documentation for the full list of available fields, definitions, and allowable values.
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 "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient being assessed. |
| Default Value | status | Identifies the workflow status of the assessment. Default: completed |
See the ClinicalImpression FHIR Documentation for the full list of available fields, definitions, and allowable values.
An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The patient who was the focus of this communication. |
| Default Value | status | The status of the transmission. Default: completed |
See the Communication FHIR Documentation for the full list of available fields, definitions, and allowable values.
A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The patient who is the focus of this communication request. |
| Default Value | status | The status of the proposal or order. Default: accepted |
See the CommunicationRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
A set of healthcare-related information that is assembled together into a single logical document 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. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). |
| Default Value | status | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. Default: final |
See the Composition FHIR Documentation for the full list of available fields, definitions, and allowable values.
A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the concept map. Default: active |
See the ConceptMap FHIR Documentation for the full list of available fields, definitions, and allowable values.
Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a diagnosis during an encounter; populating a problem list or a summary statement, such as a discharge summary.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | Indicates the patient who the condition record is associated with. |
| Default Value | clinicalStatus | The clinical status of the condition. Default: resolved when abatementDateTime has a value; active otherwise |
| Default Value | verificationStatus | The verification status to support the clinical status of the condition. Default: confirmed |
See the Condition FHIR Documentation for the full list of available fields, definitions, and allowable values.
A conformance statement is a set of capabilities of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of this conformance statement. Default: active |
See the Conformance FHIR Documentation for the full list of available fields, definitions, and allowable values.
A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
See the Contract FHIR Documentation for the full list of available fields, definitions, and allowable values.
Financial instrument which may be used to pay for or reimburse health care products and services.
| Field | Description | |
|---|---|---|
| Patient Reference | subscriber | The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due. |
See the Coverage FHIR Documentation for the full list of available fields, definitions, and allowable values.
The formal description of a single piece of information that can be gathered and reported.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the data element. Default: active |
See the DataElement FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | Indicates the patient whose record the detected issue is associated with. |
See the DetectedIssue FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource identifies an instance of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices includes durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | Patient information, if the resource is affixed to a person. |
| Default Value | status | Status of the Device availability. Default: available |
See the Device FHIR Documentation for the full list of available fields, definitions, and allowable values.
Describes the characteristics, operational status and capabilities of a medical-related component of a medical device.
See the DeviceComponent FHIR Documentation for the full list of available fields, definitions, and allowable values.
Describes a measurement, calculation or setting capability of a medical device.
See the DeviceMetric FHIR Documentation for the full list of available fields, definitions, and allowable values.
Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The patient who will use the device. |
| Default Value | status | The status of the request. Default: accepted |
See the DeviceUseRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The patient who used the device. |
See the DeviceUseStatement FHIR Documentation for the full list of available fields, definitions, and allowable values.
A record of a request for a diagnostic investigation service to be performed.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
| Default Value | status | The status of the order. Default: accepted |
See the DiagnosticOrder FHIR Documentation for the full list of available fields, definitions, and allowable values.
The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources. |
| Default Value | status | The status of the diagnostic report as a whole. Default: final |
See the DiagnosticReport FHIR Documentation for the full list of available fields, definitions, and allowable values.
A manifest that defines a set of documents.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case). |
| Default Value | status | The status of this document manifest. Default: current |
See the DocumentManifest FHIR Documentation for the full list of available fields, definitions, and allowable values.
A reference to a document .
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). |
| Default Value | status | The status of this document reference. Default: current |
| Default Value | docStatus | The status of the underlying document. Default: http://hl7.org/fhir/composition-status#final Final |
See the DocumentReference FHIR Documentation for the full list of available fields, definitions, and allowable values.
A resource that includes narrative, extensions, and contained resources.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
See the DomainResource FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides the insurance eligibility details from the insurer regarding a specified coverage and optionally some class of service.
See the EligibilityRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides eligibility and plan details from the processing of an Eligibility resource.
| Field | Description | |
|---|---|---|
| Default Value | outcome | Transaction status: error, complete. Default: complete |
See the EligibilityResponse FHIR Documentation for the full list of available fields, definitions, and allowable values.
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient present at the encounter. |
| Default Value | status | planned |
See the Encounter FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Patient Resource. |
See the EnrollmentRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides enrollment and plan details from the processing of an Enrollment resource.
| Field | Description | |
|---|---|---|
| Default Value | outcome | Transaction status: error, complete. Default: complete |
See the EnrollmentResponse FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient that this EpisodeOfCare applies to. |
| Default Value | status | planned |
See the EpisodeOfCare FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
| Field | Description | |
|---|---|---|
| Default Value | outcome | Transaction status: error, complete. Default: complete |
See the ExplanationOfBenefit FHIR Documentation for the full list of available fields, definitions, and allowable values.
Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The person who this history concerns. |
| Default Value | status | A code specifying a state of a Family Member History record. Default: completed |
| Default Value | name | This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Default: Unknown |
See the FamilyMemberHistory FHIR Documentation for the full list of available fields, definitions, and allowable values.
Prospective warnings of potential issues when providing care to the patient.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The patient, location, group , organization , or practitioner this is about record this flag is associated with. |
| Default Value | status | Supports basic workflow. Default: active |
See the Flag FHIR Documentation for the full list of available fields, definitions, and allowable values.
Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Identifies the patient, group or organization for whom the goal is being established. |
| Default Value | status | Indicates whether the goal has been reached and is still considered relevant. Default: achieved when outcome has a value; in-progress otherwise |
See the Goal FHIR Documentation for the full list of available fields, definitions, and allowable values.
Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.
See the Group FHIR Documentation for the full list of available fields, definitions, and allowable values.
The details of a healthcare service available at a location.
See the HealthcareService FHIR Documentation for the full list of available fields, definitions, and allowable values.
A manifest of a set of DICOM Service-Object Pair Instances (SOP Instances). The referenced SOP Instances (images or other content) are for a single patient, and may be from one or more studies. The referenced SOP Instances have been selected for a purpose, such as quality assurance, conference, or consult. Reflecting that range of purposes, typical ImagingObjectSelection resources may include all SOP Instances in a study (perhaps for sharing through a Health Information Exchange); key images from multiple studies (for reference by a referring or treating physician); a multi-frame ultrasound instance ("cine" video clip) and a set of measurements taken from that instance (for inclusion in a teaching file); and so on.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingObjectSelection. |
See the ImagingObjectSelection FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient imaged in the study. |
See the ImagingStudy FHIR Documentation for the full list of available fields, definitions, and allowable values.
Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient who either received or did not receive the immunization. |
| Default Value | status | Indicates the current status of the vaccination event. Default: completed |
| Default Value | wasNotGiven | Indicates if the vaccination was or was not given. Default: false |
| Default Value | reported | True if this administration was reported rather than directly administered. Default: false |
See the Immunization FHIR Documentation for the full list of available fields, definitions, and allowable values.
A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient for whom the recommendations are for. |
See the ImmunizationRecommendation FHIR Documentation for the full list of available fields, definitions, and allowable values.
A set of rules or how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole, and to publish a computable definition of all the parts.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the Implementation Guide. Default: active |
See the ImplementationGuide FHIR Documentation for the full list of available fields, definitions, and allowable values.
A set of information summarized from a list of other resources.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The common subject (or patient) of the resources that are in the list, if there is one. |
| Default Value | status | Indicates the current state of this list. Default: current |
| Default Value | mode | How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Default: working |
See the List FHIR Documentation for the full list of available fields, definitions, and allowable values.
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
| Field | Description | |
|---|---|---|
| Default Value | status | active |
See the Location FHIR Documentation for the full list of available fields, definitions, and allowable values.
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Who/What this Media is a record of. |
See the Media FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
See the Medication FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The person or animal receiving the medication. |
| Default Value | status | Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way. Default: completed |
| Default Value | wasNotGiven | Set this to true if the record is saying that the medication was NOT administered. Default: false |
| Alias | code | Alias for medicationCodeableConcept. |
See the MedicationAdministration FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | A link to a resource representing the person to whom the medication will be given. |
| Default Value | status | A code specifying the state of the set of dispense events. Default: completed |
| Alias | code | Alias for medicationCodeableConcept. |
See the MedicationDispense FHIR Documentation for the full list of available fields, definitions, and allowable values.
An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | A link to a resource representing the person to whom the medication will be given. |
| Default Value | status | A code specifying the state of the order. Generally this will be active or completed state. Default: active |
| Alias | code | Alias for medicationCodeableConcept. |
See the MedicationOrder FHIR Documentation for the full list of available fields, definitions, and allowable values.
A record of a medication that is being consumed by a patient. A MedicationStatement 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 e.g. the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains
The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement 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 statement 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.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The person or animal who is/was taking the medication. |
| Default Value | status | A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed. Default: active |
| Default Value | wasNotTaken | Set this to true if the record is saying that the medication was NOT taken. Default: false |
| Alias | code | Alias for medicationCodeableConcept. |
See the MedicationStatement FHIR Documentation for the full list of available fields, definitions, and allowable values.
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
See the MessageHeader FHIR Documentation for the full list of available fields, definitions, and allowable values.
A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | Indicates whether the naming system is "ready for use" or not. Default: active |
See the NamingSystem FHIR Documentation for the full list of available fields, definitions, and allowable values.
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding. |
| Default Value | status | The workflow status of the nutrition order/request. Default: active |
See the NutritionOrder FHIR Documentation for the full list of available fields, definitions, and allowable values.
Measurements and simple assertions made about a patient, device or other subject.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject. |
| Default Value | status | The status of the result value. Default: final |
See the Observation FHIR Documentation for the full list of available fields, definitions, and allowable values.
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the profile. Default: active |
See the OperationDefinition FHIR Documentation for the full list of available fields, definitions, and allowable values.
A collection of error, warning or information messages that result from a system action.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
See the OperationOutcome FHIR Documentation for the full list of available fields, definitions, and allowable values.
A request to perform an action.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Patient this order is about. |
See the Order FHIR Documentation for the full list of available fields, definitions, and allowable values.
A response to an order.
| Field | Description | |
|---|---|---|
| Default Value | orderStatus | What this response says about the status of the original order. Default: completed |
See the OrderResponse FHIR Documentation for the full list of available fields, definitions, and allowable values.
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
See the Organization FHIR Documentation for the full list of available fields, definitions, and allowable values.
This special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
See the Parameters FHIR Documentation for the full list of available fields, definitions, and allowable values.
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
See the Patient FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
See the PaymentNotice FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides payment details and claim references supporting a bulk payment.
| Field | Description | |
|---|---|---|
| Default Value | outcome | Transaction status: error, complete. Default: complete |
See the PaymentReconciliation FHIR Documentation for the full list of available fields, definitions, and allowable values.
Demographics and administrative information about a person independent of a specific health-related context.
See the Person FHIR Documentation for the full list of available fields, definitions, and allowable values.
A person who is directly or indirectly involved in the provisioning of healthcare.
See the Practitioner FHIR Documentation for the full list of available fields, definitions, and allowable values.
An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The person, animal or group on which the procedure was performed. |
| Default Value | status | A code specifying the state of the procedure. Generally this will be in-progress or completed state. Default: completed |
| Default Value | notPerformed | Set this to true if the record is saying that the procedure was NOT performed. Default: false |
See the Procedure FHIR Documentation for the full list of available fields, definitions, and allowable values.
A request for a procedure to be performed. May be a proposal or an order.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The person, animal or group that should receive the procedure. |
| Default Value | status | The status of the order. Default: accepted |
See the ProcedureRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.
See the ProcessRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
This resource provides processing status, errors and notes from the processing of a resource.
See the ProcessResponse FHIR Documentation for the full list of available fields, definitions, and allowable values.
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.
See the Provenance FHIR Documentation for the full list of available fields, definitions, and allowable values.
A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.
| Field | Description | |
|---|---|---|
| Default Value | status | The lifecycle status of the questionnaire as a whole. Default: published |
See the Questionnaire FHIR Documentation for the full list of available fields, definitions, and allowable values.
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 underlying questions.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. |
| Default Value | status | The lifecycle status of the questionnaire response as a whole. Default: completed |
See the QuestionnaireResponse FHIR Documentation for the full list of available fields, definitions, and allowable values.
Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient who is the subject of a referral or transfer of care request. |
| Default Value | status | The workflow status of the referral or transfer of care request. Default: accepted |
See the ReferralRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | The patient this person is related to. |
See the RelatedPerson FHIR Documentation for the full list of available fields, definitions, and allowable values.
This is the base resource type for everything.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
See the Resource FHIR Documentation for the full list of available fields, definitions, and allowable values.
An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | The patient or group the risk assessment applies to. |
See the RiskAssessment FHIR Documentation for the full list of available fields, definitions, and allowable values.
A container for slot(s) of time that may be available for booking appointments.
See the Schedule FHIR Documentation for the full list of available fields, definitions, and allowable values.
A search parameter that defines a named search item that can be used to search/filter on a resource.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of this search parameter definition. Default: active |
See the SearchParameter FHIR Documentation for the full list of available fields, definitions, and allowable values.
A slot of time on a schedule that may be available for booking appointments.
See the Slot FHIR Documentation for the full list of available fields, definitions, and allowable values.
A sample to be used for analysis.
| Field | Description | |
|---|---|---|
| Patient Reference | subject | Where the specimen came from. This may be from the patient(s) or from the environment or a device. |
| Default Value | status | The availability of the specimen. Default: available |
See the Specimen FHIR Documentation for the full list of available fields, definitions, and allowable values.
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions, and constraints on resources and data types.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the StructureDefinition. Default: active |
See the StructureDefinition FHIR Documentation for the full list of available fields, definitions, and allowable values.
The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system is able to take an appropriate action.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the subscription, which marks the server state for managing the subscription. Default: active |
See the Subscription FHIR Documentation for the full list of available fields, definitions, and allowable values.
A homogeneous material with a definite composition.
See the Substance FHIR Documentation for the full list of available fields, definitions, and allowable values.
Record of delivery of what is supplied.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | A link to a resource representing the person whom the delivered item is for. |
| Default Value | status | A code specifying the state of the dispense event. Default: completed |
See the SupplyDelivery FHIR Documentation for the full list of available fields, definitions, and allowable values.
A record of a request for a medication, substance or device used in the healthcare setting.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | A link to a resource representing the person whom the ordered item is for. |
| Default Value | status | Status of the supply request. Default: completed |
See the SupplyRequest FHIR Documentation for the full list of available fields, definitions, and allowable values.
TestScript is a resource that specifies a suite of tests against a FHIR server implementation to determine compliance against the FHIR specification.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the TestScript. Default: active |
See the TestScript FHIR Documentation for the full list of available fields, definitions, and allowable values.
A value set specifies a set of codes drawn from one or more code systems.
NOTE: It is extremely rare for CDS test authors to use this resource as patient data for CDS tests.
| Field | Description | |
|---|---|---|
| Default Value | status | The status of the value set. Default: active |
See the ValueSet FHIR Documentation for the full list of available fields, definitions, and allowable values.
An authorization for the supply of glasses and/or contact lenses to a patient.
| Field | Description | |
|---|---|---|
| Patient Reference | patient | A link to a resource representing the person to whom the vision products will be supplied. |
See the VisionPrescription FHIR Documentation for the full list of available fields, definitions, and allowable values.