Resources

Note: The FHIR documentation on this portal applies to the Altera FHIR API. For information on Paragon Open API, go here.

FHIR R4 Resource Compatibility

FHIR Resource	TouchWorks EHR (22.1 or higher)	Paragon (22.2 or higher)	Sunrise EHR US: Sunrise (22.1 or higher) + POH (22.1 or higher)	Sunrise EHR UK: Sunrise (22.1 or higher) + POH (22.3 or higher)	dbMotion (21.2CU1 or higher)
AllergyIntolerance
Binary
CarePlan
CareTeam
Condition
Coverage*
Device
DiagnosticReport
DocumentReference
Encounter
Goal
Group
Immunization
Location
Medication
MedicationAdministration
MedicationDispense*
MedicationRequest
MedicationStatement
Observation
Organization
Patient
Practitioner
PractitionerRole
Procedure
Provenance
RelatedPerson
Specimen*

• AllergyIntolerance

  R4 (US) | R4 (UK) | DSTU2
  • The AllergyIntolerance resource is used to build a list of adverse reactions and allergies associated with a patient.

• Binary

  R4 (US)
  • The Binary resource contains the data of a single raw artifact and is referenced by the DocumentReference FHIR resource.

• CarePlan

  R4 (US) | DSTU2
  • The CarePlan resource is used to describe 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.

• CareTeam

  R4 (US)
  • The CareTeam resource describes all the people, teams, and organizations who plan to participate in the coordination and delivery of care for a single patient or a group.

• Condition

  R4 (US) | DSTU2
  • The Condition resource is used to record detailed information about a condition, problem, diagnosis, event, situation, issue, or clinical concept that has risen to a level of concern.

• Coverage

  R4 (US)
  • The Coverage resource is used to represent the financial details of an insurance plan for a specific patient.

• Device

  R4 (US) | DSTU2
  • The Device resource is an administrative resource that tracks individual instances of a device and their location. It is referenced by other resources for recording which device performed an action such as a procedure or an observation, referenced when prescribing and dispensing devices for patient use or for ordering supplies, and used to record and transmit Unique Device Identifier (UDI) information about a device such as a patient's implant.

• DiagnosticOrder

  DSTU2
  • The DiagnosticOrder resource records a request for a set of diagnostic investigations to be performed.

• DiagnosticReport

  R4 (US) | DSTU2
  • The DiagnosticReport resource is used to document 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. Laboratory results are grouped and summarized using the DiagnosticReport resource which typically reference Observation resources.

• DocumentReference

  R4 (US) | DSTU2
  • The DocumentReference resource references a document of any kind for any purpose. It provides metadata about the document so that the document can be discovered and managed. This includes formal patient centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text.

• Encounter

  R4 (US)
  • The Encounter resource is used to describe an interaction between a patient and healthcare provider for the purpose of providing healthcare service or assessing the health status of a patient. A patient encounter is further characterized by the setting in which it takes place. Amongst them are ambulatory, emergency, home health, inpatient and virtual encounters.

• Goal

  R4 (US) | DSTU2
  • The Goal resource is used to describe 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, and so forth.

• Group

  R4 (US)
  • The Group resource is used to represent 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. For example, a collection of entities that isn't an organization. The Altera FHIR API utilizes the Group resource in conjunction with bulk data export. For more information on bulk data, see https://developer.dev.open.adhdevelop.com/Fhir/BulkData.

• Immunization

  R4 (US) | DSTU2
  • The Immunization resource is used to describe 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.

• Location

  R4 (US) | R4 (UK)
  • The Location resource is used to describe a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

• Medication

  R4 (US) | R4 (UK)
  • The Medication resource is used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

• MedicationAdministration

  R4 (UK)
  • The MedicationAdministration resource is used to pass information about the event of a patient consuming or otherwise being administered a medication.

• MedicationDispense

  R4 (US)
  • The MedicationDispense resource used to document 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.

• MedicationOrder

  DSTU2
  • The MedicationOrder resource is used to document an?order for both supply of the medication and the instructions for administration of the medication to a patient.

• MedicationRequest

  R4 (US) | R4 (UK)
  • The MedicationRequest resource is used to document orders or requests for both a supply of the medication and the instructions for administration of a medication to a patient.

• MedicationStatement

  DSTU2 | R4 (UK)
  • The MedicationStatement resource is used to document a record of a medication that is being consumed by a patient.

• Observation

  R4 (US) | DSTU2
  • The Observation resource is used to support patient diagnosis, monitor progress, determine baselines and patterns, and capture demographic characteristics. Depending on the LOINC code returned in the code value, the API returns the Observation using the appropriate profile. For example, if the code is 72166-2, the API uses the Smoking Status profile.

• Organization

  R4 (US) | R4 (UK)
  • The Organization resource is used to describe a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. This includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, and so forth.

• Patient

  R4 (US) | R4 (UK) | DSTU2
  • The Patient resource contains demographics and other administrative information about an individual receiving care or other health-related services.

• Practitioner

  R4 (US) | R4 (UK)
  • The Practitioner resource is used to describe a person who is directly or indirectly involved in the provisioning of healthcare.

• PractitionerRole

  R4 (US) | R4 (UK)
  • The PractitionerRole resource describes the types of services that Practitioners are able to provide for an organization.

• Procedure

  R4 (US) | DSTU2
  • The Procedure resource is used to describe an action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services or counseling.

• Provenance

  R4 (US)
  • The Provenance resource tracks information about the activity that created, revised, deleted, or signed a version of a resource, describing the entities and agents involved. This information can be used to form assessments about its quality, reliability, trustworthiness, or to provide pointers for where to go to further investigate the origins of the resource and the information in it.

• RelatedPerson

  R4 (US)
  • The RelatedPerson resource contains 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.

• Specimen

  R4 (US)
  • A Specimen Resource is defined as a sample collected from a source, such as an environmental location or an anatomical site, for the purpose of analysis or testing.