# Get FHIR r4 example scenarios Endpoint: GET /site/{siteId}/fhir/example-scenario Version: 1.0 Security: bearer, bearer ## Path parameters: - `siteId` (string, required) Site identifier ## Query parameters: - `_count` (number) Number of items to return (default=20). Example: 10 - `_page_token` (string) Token for fetching the next page of results. Example: "CgYK..." - `_sort` (string) Sort the results by a given field, e.g. _sort=family or _sort=-date. Example: "family" - `_elements` (string) Restrict returned fields, e.g. _elements=identifier,name. Example: "identifier,name" - `telecom` (string) Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE]. Example: "telecom=phone|555-555-5555" - `_id` (string) Search for a specific resource by ID, e.g. _id=abc123. Example: "abc123" - `identifier` (string) Search for resources by identifier token, e.g. identifier=http://hospital.org|12345. Example: "http://hospital.org|12345" - `_include` (string) Include related resources, e.g. _include=Appointment:patient. Example: "Appointment:patient" - `patient` (string) Include related patient resources, e.g. patient=Patient/[id]&. Example: "patient=Patient/[id]&" - `_revinclude` (string) Reverse include related resources, e.g. _revinclude=Observation:subject. Example: "Observation:subject" - `_has` (string) Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5. Example: "Observation:subject:code=http://loinc.org|1234-5" - `_tag` (string) Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag. Example: "http://example.org/tags|sample-tag" - `_security` (string) Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL. Example: "RBAC|CONFIDENTIAL" - `_profile` (string) Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile. Example: "http://example.org/fhir/StructureDefinition/custom-profile" ## Response 200 fields (application/json): - `resourceType` (any, required) This is a Bundle resource Enum: "Bundle" - `id` (string) Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. Example: "example-id" - `meta` (object) The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `meta.id` (string) An extension object type #string. Example: "example-string" - `meta.extension` (array) May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. - `meta.versionId` (object) An extension object type #id. - `meta._versionId` (object) An extension object type #Element. - `meta.lastUpdated` (object) An extension object type #instant. - `meta._lastUpdated` (object) An extension object type #Element. - `meta.source` (string) An extension object type #uri. Example: "https://example.org/resource" - `meta._source` (object) An extension object type #Element. - `meta.profile` (array) A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Example: ["http://example.org/Profile"] - `meta.security` (array) Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. - `meta.tag` (array) Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. - `implicitRules` (string) String of characters used to identify a name or a resource Example: "https://example.org/resource" - `_implicitRules` (object) Base definition for all elements in a resource. - `language` (string) A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents Example: "sample-code" - `_language` (object) Base definition for all elements in a resource. - `identifier` (object) An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. - `identifier.use` (any) The purpose of this identifier. Enum: "usual", "official", "temp", "secondary", "old" - `identifier._use` (object) An extension object type #Element. - `identifier.type` (object) An extension object type #CodeableConcept. - `identifier.system` (string) An extension object type #uri. Example: "https://example.org/resource" - `identifier._system` (object) An extension object type #Element. - `identifier.value` (string) An extension object type #string. Example: "example-string" - `identifier._value` (object) An extension object type #Element. - `identifier.period` (object) An extension object type #Period. - `identifier.assigner` (object) An extension object type #Reference. - `type` (any) Indicates the purpose of this bundle - how it is intended to be used. Enum: "document", "message", "transaction", "transaction-response", "batch", "batch-response", "history", "searchset", "collection" - `_type` (object) Base definition for all elements in a resource. - `timestamp` (string) An instant in time - known at least to the second Example: "2024-01-01T00:00:00Z" - `_timestamp` (object) Base definition for all elements in a resource. - `total` (number) An integer with a value that is not negative (e.g. >= 0) - `_total` (object) Base definition for all elements in a resource. - `link` (array) A series of links that provide context to this bundle. Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/example-scenario/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/example-scenario/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/example-scenario/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/example-scenario/?_count=20"}] - `link.modifierExtension` (array) May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). - `link.relation` (string) An extension object type #string. Example: "example-string" - `link._relation` (object) An extension object type #Element. - `link.url` (string) An extension object type #uri. Example: "https://example.org/resource" - `link._url` (object) An extension object type #Element. - `entry` (array) An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). Example: [{"resourceType":"ExampleScenario","id":"example","text":{"status":"generated","div":"
Generated Narrative with Details
id: example
status: draft
purpose: Purpose: this serves to enable remote performing of medication administration, by using remote / mobile devices to a) Get the planned medication administrations and b) Record the performing of these administrations without a permanent connection to the EHR.
actor
actorId: Nurse
type: person
name: Nurse
description: The Nurse
actor
actorId: MAP
type: entity
name: Nurse's Tablet
description: The entity that receives the Administration Requests to show the nurse to perform them
actor
actorId: OP
type: entity
name: MAR / Scheduler
description: The Medication Administration Order Placer
actor
actorId: MAC
type: entity
name: MAR / EHR
description: The entity that receives the Medication Administration reports
instance
resourceId: iherx001
resourceType: MedicationRequest
name: Initial Prescription
description: The initial prescription which describes "medication X, 3 times per day" - the exact scheduling is not in the initial prescription (it is left for the care teams to decide on the schedule).
instance
resourceId: iherx001.001
resourceType: MedicationRequest
name: Request for day 1, morning
description: The administration request for day 1, morning
instance
resourceId: iherx001.002
resourceType: MedicationRequest
name: Request for day 1, lunch
description: The administration request for day 1, lunch
instance
resourceId: iherx001.003
resourceType: MedicationRequest
name: Request for day 1, evening
description: The administration request for day 1, evening
instance
resourceId: iherx001.004
resourceType: MedicationRequest
name: Request for day 2, morning
description: The administration request for day 2, morning
instance
resourceId: iherx001.005
resourceType: MedicationRequest
name: Request for day 2, lunch
description: The administration request for day 2, lunch
instance
resourceId: iherx001.006
resourceType: MedicationRequest
name: Request for day 2, evening
description: The administration request for day 2, evening
instance
resourceId: iheadm001a
resourceType: MedicationAdministration
name: Morning meds - taken
description: Administration report for day 1, morning: Taken
instance
resourceId: iheadm001b
resourceType: MedicationAdministration
name: Morning meds - not taken
description: Administration report for day 1, morning: NOT Taken
instance
resourceId: iherx001bundle
resourceType: MedicationRequest
name: Bundle of Medication Requests
description: All the medication Requests for Day 1
containedInstance
resourceId: iherx001.001
containedInstance
resourceId: iherx001.002
containedInstance
resourceId: iherx001.003
containedInstance
resourceId: iherx001.004
containedInstance
resourceId: iherx001.005
containedInstance
resourceId: iherx001.006
instance
resourceId: iheadm002
resourceType: MedicationAdministration
name: Lunch meds - taken
description: Administration report for day 1, lunch: Taken
version
versionId: iheadm002v1
description: Medication just taken
version
versionId: iheadm002v2
description: Medication rejected
instance
resourceId: iherxqry
resourceType: SearchParameter
name: Search query1
description: The search administration request for day 1, morning
process
title: Mobile Medication Administration
description: This scenario demonstrates the process of getting the relevant medication instructions for a patient visit and reporting the results of administration. The scenario is as follows: After the prescription is issued, the institution schedules each individual administration event in the Medication Administration Record (MAR). When preparing for a visit, the nurse queries the MAR for the scheduled administrations, obtaining a bundle of records. The nurse then performs the care activities and registers the results in the device. Upon synchronization of the device and the institution, the results of administration are uploaded to the EHR, thus updating the MAR.
preConditions: Medication administration requests are in the EHR / MAR, scheduled for each individual intake.
postConditions: Medication administration Reports are submitted, EHR is updated.
step
Operations
- Number Name Initiator Receiver * 1 1. Get today's schedule Nurse MAP step
Processes
- * step
pause: true
step
Operations
- Number Name Initiator Receiver * 4 Notify (alert) MAP Nurse step
Operations
- Number Name Initiator Receiver * 5 Read orders Nurse MAP step
pause: true
step
Operations
- Number Name Initiator Receiver * 5 Ask if patient took meds Nurse Nurse step
alternative
title: Patient took drugs
description: Invoke if patient took medications
Steps
- * alternative
title: No drugs
description: No, patient did not take drugs
Steps
- * alternative
title: Not clear
description: Unknown whether patient took medications or not
Steps
- * step
pause: true
step
Operations
- Number Name Initiator Receiver * 6 Administer drug Nurse Nurse step
Operations
- Number Name Initiator Receiver InitiatorActive * 7 Register administration Nurse MAP true step
pause: true
step
Processes
- * step
pause: true
step
Processes
- *