# Update FHIR r4 example scenario Endpoint: PUT /site/{siteId}/fhir/example-scenario/{id} Version: 1.0 Security: bearer, bearer ## Path parameters: - `siteId` (string, required) Site identifier - `id` (string, required) ID of the ExampleScenario to update ## Request fields (application/json): - `resourceType` (any, required) This is a ExampleScenario resource Enum: "ExampleScenario" - `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. - `text` (object) A human-readable summary of the resource conveying the essential clinical and business information for the resource. - `text.status` (any) The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Enum: "generated", "extensions", "additional", "empty" - `text._status` (object) An extension object type #Element. - `text.div` (string, required) An extension object type #xhtml. Example: "
Example
" - `contained` (array) These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. - `extension` (array) May be used to represent additional information that is not part of the basic definition of the resource. 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. - `extension.url` (string) An extension object type #uri. Example: "https://example.org/resource" - `extension._url` (object) An extension object type #Element. - `extension.valueBase64Binary` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "U2FtcGxl" - `extension._valueBase64Binary` (object) An extension object type #Element. - `extension.valueBoolean` (boolean) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: true - `extension._valueBoolean` (object) An extension object type #Element. - `extension.valueCanonical` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "http://example.org/Profile" - `extension._valueCanonical` (object) An extension object type #Element. - `extension.valueCode` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "sample-code" - `extension._valueCode` (object) An extension object type #Element. - `extension.valueDate` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01" - `extension._valueDate` (object) An extension object type #Element. - `extension.valueDateTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueDateTime` (object) An extension object type #Element. - `extension.valueDecimal` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1.23 - `extension._valueDecimal` (object) An extension object type #Element. - `extension.valueId` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-id" - `extension._valueId` (object) An extension object type #Element. - `extension.valueInstant` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueInstant` (object) An extension object type #Element. - `extension.valueInteger` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valueInteger` (object) An extension object type #Element. - `extension.valueMarkdown` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "Sample markdown text" - `extension._valueMarkdown` (object) An extension object type #Element. - `extension.valueOid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:oid:1.2.3.4.5" - `extension._valueOid` (object) An extension object type #Element. - `extension.valuePositiveInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valuePositiveInt` (object) An extension object type #Element. - `extension.valueString` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-string" - `extension._valueString` (object) An extension object type #Element. - `extension.valueTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "12:00:00" - `extension._valueTime` (object) An extension object type #Element. - `extension.valueUnsignedInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). - `extension._valueUnsignedInt` (object) An extension object type #Element. - `extension.valueUri` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org/resource" - `extension._valueUri` (object) An extension object type #Element. - `extension.valueUrl` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org" - `extension._valueUrl` (object) An extension object type #Element. - `extension.valueUuid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000" - `extension._valueUuid` (object) An extension object type #Element. - `extension.valueAddress` (object) An extension object type #Address. - `extension.valueAge` (object) An extension object type #Age. - `extension.valueAnnotation` (object) An extension object type #Annotation. - `extension.valueAttachment` (object) An extension object type #Attachment. - `extension.valueCodeableConcept` (object) An extension object type #CodeableConcept. - `extension.valueCoding` (object) An extension object type #Coding. - `extension.valueContactPoint` (object) An extension object type #ContactPoint. - `extension.valueCount` (object) An extension object type #Count. - `extension.valueDistance` (object) An extension object type #Distance. - `extension.valueDuration` (object) An extension object type #Duration. - `extension.valueHumanName` (object) An extension object type #HumanName. - `extension.valueIdentifier` (object) An extension object type #Identifier. - `extension.valueMoney` (object) An extension object type #Money. - `extension.valuePeriod` (object) An extension object type #Period. - `extension.valueQuantity` (object) An extension object type #Quantity. - `extension.valueRange` (object) An extension object type #Range. - `extension.valueRatio` (object) An extension object type #Ratio. - `extension.valueReference` (object) An extension object type #Reference. - `extension.valueSampledData` (object) An extension object type #SampledData. - `extension.valueSignature` (object) An extension object type #Signature. - `extension.valueTiming` (object) An extension object type #Timing. - `extension.valueContactDetail` (object) An extension object type #ContactDetail. - `extension.valueContributor` (object) An extension object type #Contributor. - `extension.valueDataRequirement` (object) An extension object type #DataRequirement. - `extension.valueExpression` (object) An extension object type #Expression. - `extension.valueParameterDefinition` (object) An extension object type #ParameterDefinition. - `extension.valueRelatedArtifact` (object) An extension object type #RelatedArtifact. - `extension.valueTriggerDefinition` (object) An extension object type #TriggerDefinition. - `extension.valueUsageContext` (object) An extension object type #UsageContext. - `extension.valueDosage` (object) An extension object type #Dosage. - `extension.valueMeta` (object) An extension object type #Meta. - `modifierExtension` (array) May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). - `url` (string) String of characters used to identify a name or a resource Example: "https://example.org/resource" - `_url` (object) Base definition for all elements in a resource. - `identifier` (array) A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance. - `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. - `version` (string) A sequence of Unicode characters Example: "example-string" - `_version` (object) Base definition for all elements in a resource. - `name` (string) A sequence of Unicode characters Example: "example-string" - `_name` (object) Base definition for all elements in a resource. - `status` (any) The status of this example scenario. Enables tracking the life-cycle of the content. Enum: "draft", "active", "retired", "unknown" - `_status` (object) Base definition for all elements in a resource. - `experimental` (boolean) Value of "true" or "false" Example: true - `_experimental` (object) Base definition for all elements in a resource. - `date` (string) A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. Example: "2024-01-01T00:00:00Z" - `_date` (object) Base definition for all elements in a resource. - `publisher` (string) A sequence of Unicode characters Example: "example-string" - `_publisher` (object) Base definition for all elements in a resource. - `contact` (array) Contact details to assist a user in finding and communicating with the publisher. - `contact.name` (string) An extension object type #string. Example: "example-string" - `contact._name` (object) An extension object type #Element. - `contact.telecom` (array) The contact details for the individual (if a name was provided) or the organization. - `useContext` (array) The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances. - `useContext.code` (object, required) An extension object type #Coding. - `jurisdiction` (array) A legal or geographic region in which the example scenario is intended to be used. - `jurisdiction.coding` (array) A reference to a code defined by a terminology system. - `jurisdiction.text` (string) An extension object type #string. Example: "example-string" - `jurisdiction._text` (object) An extension object type #Element. - `copyright` (string) A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine Example: "Sample markdown text" - `_copyright` (object) Base definition for all elements in a resource. - `purpose` (string) A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine Example: "Sample markdown text" - `_purpose` (object) Base definition for all elements in a resource. - `actor` (array) Actor participating in the resource. Example: [{"actorId":"Nurse","type":"person","name":"Nurse","description":"The Nurse"},{"actorId":"MAP","type":"entity","name":"Nurse's Tablet","description":"The entity that receives the Administration Requests to show the nurse to perform them"},{"actorId":"OP","type":"entity","name":"MAR / Scheduler","description":"The Medication Administration Order Placer"},{"actorId":"MAC","type":"entity","name":"MAR / EHR","description":"The entity that receives the Medication Administration reports"}] - `actor.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). - `actor.actorId` (string) An extension object type #string. Example: "example-string" - `actor._actorId` (object) An extension object type #Element. - `actor.type` (any) The type of actor - person or system. Enum: "person", "entity" - `actor._type` (object) An extension object type #Element. - `actor.description` (object) An extension object type #markdown. - `actor._description` (object) An extension object type #Element. - `instance` (array) Each resource and each version that is present in the workflow. Example: [{"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)."},{"resourceId":"iherx001.001","resourceType":"MedicationRequest","name":"Request for day 1, morning","description":"The administration request for day 1, morning"},{"resourceId":"iherx001.002","resourceType":"MedicationRequest","name":"Request for day 1, lunch","description":"The administration request for day 1, lunch"},{"resourceId":"iherx001.003","resourceType":"MedicationRequest","name":"Request for day 1, evening","description":"The administration request for day 1, evening"},{"resourceId":"iherx001.004","resourceType":"MedicationRequest","name":"Request for day 2, morning","description":"The administration request for day 2, morning"},{"resourceId":"iherx001.005","resourceType":"MedicationRequest","name":"Request for day 2, lunch","description":"The administration request for day 2, lunch"},{"resourceId":"iherx001.006","resourceType":"MedicationRequest","name":"Request for day 2, evening","description":"The administration request for day 2, evening"},{"resourceId":"iheadm001a","resourceType":"MedicationAdministration","name":"Morning meds - taken","description":"Administration report for day 1, morning: Taken"},{"resourceId":"iheadm001b","resourceType":"MedicationAdministration","name":"Morning meds - not taken","description":"Administration report for day 1, morning: NOT Taken"},{"resourceId":"iherx001bundle","resourceType":"MedicationRequest","name":"Bundle of Medication Requests","description":"All the medication Requests for Day 1","containedInstance":[{"resourceId":"iherx001.001"},{"resourceId":"iherx001.002"},{"resourceId":"iherx001.003"},{"resourceId":"iherx001.004"},{"resourceId":"iherx001.005"},{"resourceId":"iherx001.006"}]},{"resourceId":"iheadm002","resourceType":"MedicationAdministration","name":"Lunch meds - taken","description":"Administration report for day 1, lunch: Taken","version":[{"versionId":"iheadm002v1","description":"Medication just taken"},{"versionId":"iheadm002v2","description":"Medication rejected"}]},{"resourceId":"iherxqry","resourceType":"SearchParameter","name":"Search query1","description":"The search administration request for day 1, morning"}] - `instance.resourceId` (string) An extension object type #string. Example: "example-string" - `instance._resourceId` (object) An extension object type #Element. - `instance.resourceType` (string) An extension object type #code. Example: "sample-code" - `instance._resourceType` (object) An extension object type #Element. - `instance.version` (array) A specific version of the resource. - `instance.containedInstance` (array) Resources contained in the instance (e.g. the observations contained in a bundle). - `process` (array) Each major process - a group of operations. Example: [{"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":[{"operation":{"number":"1","name":"1. Get today's schedule","initiator":"Nurse","receiver":"MAP"}},{"process":[{"title":"P1. Query Administration Requests","description":"Query for medication administration orders,\\n- For today's shifts\\n- For today's patients","step":[{"operation":{"number":"2","name":"2.Query for medication administration orders,\\n- For today's shifts\\n- For today's patients","initiator":"MAP","receiver":"OP","request":{"resourceId":"iherxqry"},"response":{"resourceId":"iherx001bundle"}}}]}]},{"pause":true},{"operation":{"number":"4","name":"Notify (alert)","initiator":"MAP","receiver":"Nurse"}},{"operation":{"number":"5","name":"Read orders","initiator":"Nurse","receiver":"MAP"}},{"pause":true},{"operation":{"number":"5","name":"Ask if patient took meds","initiator":"Nurse","receiver":"Nurse"}},{"alternative":[{"title":"Patient took drugs","description":"Invoke if patient took medications","step":[{"process":[{"title":"Register Meds taken","step":[{"operation":{"number":"1a","name":"Register Meds taken","initiator":"Nurse","receiver":"MAP","initiatorActive":true}}]}]}]},{"title":"No drugs","description":"No, patient did not take drugs","step":[{"process":[{"title":"Register Meds NOT taken","step":[{"operation":{"number":"1b","name":"Register Meds NOT taken","initiator":"Nurse","receiver":"MAP","initiatorActive":true}}]}]}]},{"title":"Not clear","description":"Unknown whether patient took medications or not","step":[{"pause":true}]}]},{"pause":true},{"operation":{"number":"6","name":"Administer drug","initiator":"Nurse","receiver":"Nurse"}},{"operation":{"number":"7","name":"Register administration","initiator":"Nurse","receiver":"MAP","initiatorActive":true}},{"pause":true},{"process":[{"title":"P2. Update administration reports","step":[{"operation":{"number":"8","name":"Nurse updates administration report","initiator":"Nurse","receiver":"MAP","initiatorActive":true,"request":{"resourceId":"iheadm002"}}}]}]},{"pause":true},{"process":[{"title":"P3. Upload administration reports","description":"The nurse's system uploads the administration results to the server","step":[{"operation":{"number":"9","name":"Refresh","initiator":"MAP","receiver":"MAC","request":{"resourceId":"iheadm001"}}}]}]}]}] - `process.title` (string) An extension object type #string. Example: "example-string" - `process._title` (object) An extension object type #Element. - `process.preConditions` (object) An extension object type #markdown. - `process._preConditions` (object) An extension object type #Element. - `process.postConditions` (object) An extension object type #markdown. - `process._postConditions` (object) An extension object type #Element. - `process.step` (array) Each step of the process. - `workflow` (array) Another nested workflow. Example: ["http://example.org/Profile"] ## Response 200 fields (application/json): - `resourceType` (any, required) This is a ExampleScenario resource Enum: "ExampleScenario" - `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. - `text` (object) A human-readable summary of the resource conveying the essential clinical and business information for the resource. - `text.status` (any) The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Enum: "generated", "extensions", "additional", "empty" - `text._status` (object) An extension object type #Element. - `text.div` (string, required) An extension object type #xhtml. Example: "
Example
" - `contained` (array) These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. - `extension` (array) May be used to represent additional information that is not part of the basic definition of the resource. 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. - `extension.url` (string) An extension object type #uri. Example: "https://example.org/resource" - `extension._url` (object) An extension object type #Element. - `extension.valueBase64Binary` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "U2FtcGxl" - `extension._valueBase64Binary` (object) An extension object type #Element. - `extension.valueBoolean` (boolean) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: true - `extension._valueBoolean` (object) An extension object type #Element. - `extension.valueCanonical` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "http://example.org/Profile" - `extension._valueCanonical` (object) An extension object type #Element. - `extension.valueCode` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "sample-code" - `extension._valueCode` (object) An extension object type #Element. - `extension.valueDate` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01" - `extension._valueDate` (object) An extension object type #Element. - `extension.valueDateTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueDateTime` (object) An extension object type #Element. - `extension.valueDecimal` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1.23 - `extension._valueDecimal` (object) An extension object type #Element. - `extension.valueId` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-id" - `extension._valueId` (object) An extension object type #Element. - `extension.valueInstant` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueInstant` (object) An extension object type #Element. - `extension.valueInteger` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valueInteger` (object) An extension object type #Element. - `extension.valueMarkdown` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "Sample markdown text" - `extension._valueMarkdown` (object) An extension object type #Element. - `extension.valueOid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:oid:1.2.3.4.5" - `extension._valueOid` (object) An extension object type #Element. - `extension.valuePositiveInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valuePositiveInt` (object) An extension object type #Element. - `extension.valueString` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-string" - `extension._valueString` (object) An extension object type #Element. - `extension.valueTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "12:00:00" - `extension._valueTime` (object) An extension object type #Element. - `extension.valueUnsignedInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). - `extension._valueUnsignedInt` (object) An extension object type #Element. - `extension.valueUri` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org/resource" - `extension._valueUri` (object) An extension object type #Element. - `extension.valueUrl` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org" - `extension._valueUrl` (object) An extension object type #Element. - `extension.valueUuid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000" - `extension._valueUuid` (object) An extension object type #Element. - `extension.valueAddress` (object) An extension object type #Address. - `extension.valueAge` (object) An extension object type #Age. - `extension.valueAnnotation` (object) An extension object type #Annotation. - `extension.valueAttachment` (object) An extension object type #Attachment. - `extension.valueCodeableConcept` (object) An extension object type #CodeableConcept. - `extension.valueCoding` (object) An extension object type #Coding. - `extension.valueContactPoint` (object) An extension object type #ContactPoint. - `extension.valueCount` (object) An extension object type #Count. - `extension.valueDistance` (object) An extension object type #Distance. - `extension.valueDuration` (object) An extension object type #Duration. - `extension.valueHumanName` (object) An extension object type #HumanName. - `extension.valueIdentifier` (object) An extension object type #Identifier. - `extension.valueMoney` (object) An extension object type #Money. - `extension.valuePeriod` (object) An extension object type #Period. - `extension.valueQuantity` (object) An extension object type #Quantity. - `extension.valueRange` (object) An extension object type #Range. - `extension.valueRatio` (object) An extension object type #Ratio. - `extension.valueReference` (object) An extension object type #Reference. - `extension.valueSampledData` (object) An extension object type #SampledData. - `extension.valueSignature` (object) An extension object type #Signature. - `extension.valueTiming` (object) An extension object type #Timing. - `extension.valueContactDetail` (object) An extension object type #ContactDetail. - `extension.valueContributor` (object) An extension object type #Contributor. - `extension.valueDataRequirement` (object) An extension object type #DataRequirement. - `extension.valueExpression` (object) An extension object type #Expression. - `extension.valueParameterDefinition` (object) An extension object type #ParameterDefinition. - `extension.valueRelatedArtifact` (object) An extension object type #RelatedArtifact. - `extension.valueTriggerDefinition` (object) An extension object type #TriggerDefinition. - `extension.valueUsageContext` (object) An extension object type #UsageContext. - `extension.valueDosage` (object) An extension object type #Dosage. - `extension.valueMeta` (object) An extension object type #Meta. - `modifierExtension` (array) May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). - `url` (string) String of characters used to identify a name or a resource Example: "https://example.org/resource" - `_url` (object) Base definition for all elements in a resource. - `identifier` (array) A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance. - `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. - `version` (string) A sequence of Unicode characters Example: "example-string" - `_version` (object) Base definition for all elements in a resource. - `name` (string) A sequence of Unicode characters Example: "example-string" - `_name` (object) Base definition for all elements in a resource. - `status` (any) The status of this example scenario. Enables tracking the life-cycle of the content. Enum: "draft", "active", "retired", "unknown" - `_status` (object) Base definition for all elements in a resource. - `experimental` (boolean) Value of "true" or "false" Example: true - `_experimental` (object) Base definition for all elements in a resource. - `date` (string) A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. Example: "2024-01-01T00:00:00Z" - `_date` (object) Base definition for all elements in a resource. - `publisher` (string) A sequence of Unicode characters Example: "example-string" - `_publisher` (object) Base definition for all elements in a resource. - `contact` (array) Contact details to assist a user in finding and communicating with the publisher. - `contact.name` (string) An extension object type #string. Example: "example-string" - `contact._name` (object) An extension object type #Element. - `contact.telecom` (array) The contact details for the individual (if a name was provided) or the organization. - `useContext` (array) The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances. - `useContext.code` (object, required) An extension object type #Coding. - `jurisdiction` (array) A legal or geographic region in which the example scenario is intended to be used. - `jurisdiction.coding` (array) A reference to a code defined by a terminology system. - `jurisdiction.text` (string) An extension object type #string. Example: "example-string" - `jurisdiction._text` (object) An extension object type #Element. - `copyright` (string) A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine Example: "Sample markdown text" - `_copyright` (object) Base definition for all elements in a resource. - `purpose` (string) A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine Example: "Sample markdown text" - `_purpose` (object) Base definition for all elements in a resource. - `actor` (array) Actor participating in the resource. Example: [{"actorId":"Nurse","type":"person","name":"Nurse","description":"The Nurse"},{"actorId":"MAP","type":"entity","name":"Nurse's Tablet","description":"The entity that receives the Administration Requests to show the nurse to perform them"},{"actorId":"OP","type":"entity","name":"MAR / Scheduler","description":"The Medication Administration Order Placer"},{"actorId":"MAC","type":"entity","name":"MAR / EHR","description":"The entity that receives the Medication Administration reports"}] - `actor.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). - `actor.actorId` (string) An extension object type #string. Example: "example-string" - `actor._actorId` (object) An extension object type #Element. - `actor.type` (any) The type of actor - person or system. Enum: "person", "entity" - `actor._type` (object) An extension object type #Element. - `actor.description` (object) An extension object type #markdown. - `actor._description` (object) An extension object type #Element. - `instance` (array) Each resource and each version that is present in the workflow. Example: [{"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)."},{"resourceId":"iherx001.001","resourceType":"MedicationRequest","name":"Request for day 1, morning","description":"The administration request for day 1, morning"},{"resourceId":"iherx001.002","resourceType":"MedicationRequest","name":"Request for day 1, lunch","description":"The administration request for day 1, lunch"},{"resourceId":"iherx001.003","resourceType":"MedicationRequest","name":"Request for day 1, evening","description":"The administration request for day 1, evening"},{"resourceId":"iherx001.004","resourceType":"MedicationRequest","name":"Request for day 2, morning","description":"The administration request for day 2, morning"},{"resourceId":"iherx001.005","resourceType":"MedicationRequest","name":"Request for day 2, lunch","description":"The administration request for day 2, lunch"},{"resourceId":"iherx001.006","resourceType":"MedicationRequest","name":"Request for day 2, evening","description":"The administration request for day 2, evening"},{"resourceId":"iheadm001a","resourceType":"MedicationAdministration","name":"Morning meds - taken","description":"Administration report for day 1, morning: Taken"},{"resourceId":"iheadm001b","resourceType":"MedicationAdministration","name":"Morning meds - not taken","description":"Administration report for day 1, morning: NOT Taken"},{"resourceId":"iherx001bundle","resourceType":"MedicationRequest","name":"Bundle of Medication Requests","description":"All the medication Requests for Day 1","containedInstance":[{"resourceId":"iherx001.001"},{"resourceId":"iherx001.002"},{"resourceId":"iherx001.003"},{"resourceId":"iherx001.004"},{"resourceId":"iherx001.005"},{"resourceId":"iherx001.006"}]},{"resourceId":"iheadm002","resourceType":"MedicationAdministration","name":"Lunch meds - taken","description":"Administration report for day 1, lunch: Taken","version":[{"versionId":"iheadm002v1","description":"Medication just taken"},{"versionId":"iheadm002v2","description":"Medication rejected"}]},{"resourceId":"iherxqry","resourceType":"SearchParameter","name":"Search query1","description":"The search administration request for day 1, morning"}] - `instance.resourceId` (string) An extension object type #string. Example: "example-string" - `instance._resourceId` (object) An extension object type #Element. - `instance.resourceType` (string) An extension object type #code. Example: "sample-code" - `instance._resourceType` (object) An extension object type #Element. - `instance.version` (array) A specific version of the resource. - `instance.containedInstance` (array) Resources contained in the instance (e.g. the observations contained in a bundle). - `process` (array) Each major process - a group of operations. Example: [{"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":[{"operation":{"number":"1","name":"1. Get today's schedule","initiator":"Nurse","receiver":"MAP"}},{"process":[{"title":"P1. Query Administration Requests","description":"Query for medication administration orders,\\n- For today's shifts\\n- For today's patients","step":[{"operation":{"number":"2","name":"2.Query for medication administration orders,\\n- For today's shifts\\n- For today's patients","initiator":"MAP","receiver":"OP","request":{"resourceId":"iherxqry"},"response":{"resourceId":"iherx001bundle"}}}]}]},{"pause":true},{"operation":{"number":"4","name":"Notify (alert)","initiator":"MAP","receiver":"Nurse"}},{"operation":{"number":"5","name":"Read orders","initiator":"Nurse","receiver":"MAP"}},{"pause":true},{"operation":{"number":"5","name":"Ask if patient took meds","initiator":"Nurse","receiver":"Nurse"}},{"alternative":[{"title":"Patient took drugs","description":"Invoke if patient took medications","step":[{"process":[{"title":"Register Meds taken","step":[{"operation":{"number":"1a","name":"Register Meds taken","initiator":"Nurse","receiver":"MAP","initiatorActive":true}}]}]}]},{"title":"No drugs","description":"No, patient did not take drugs","step":[{"process":[{"title":"Register Meds NOT taken","step":[{"operation":{"number":"1b","name":"Register Meds NOT taken","initiator":"Nurse","receiver":"MAP","initiatorActive":true}}]}]}]},{"title":"Not clear","description":"Unknown whether patient took medications or not","step":[{"pause":true}]}]},{"pause":true},{"operation":{"number":"6","name":"Administer drug","initiator":"Nurse","receiver":"Nurse"}},{"operation":{"number":"7","name":"Register administration","initiator":"Nurse","receiver":"MAP","initiatorActive":true}},{"pause":true},{"process":[{"title":"P2. Update administration reports","step":[{"operation":{"number":"8","name":"Nurse updates administration report","initiator":"Nurse","receiver":"MAP","initiatorActive":true,"request":{"resourceId":"iheadm002"}}}]}]},{"pause":true},{"process":[{"title":"P3. Upload administration reports","description":"The nurse's system uploads the administration results to the server","step":[{"operation":{"number":"9","name":"Refresh","initiator":"MAP","receiver":"MAC","request":{"resourceId":"iheadm001"}}}]}]}]}] - `process.title` (string) An extension object type #string. Example: "example-string" - `process._title` (object) An extension object type #Element. - `process.preConditions` (object) An extension object type #markdown. - `process._preConditions` (object) An extension object type #Element. - `process.postConditions` (object) An extension object type #markdown. - `process._postConditions` (object) An extension object type #Element. - `process.step` (array) Each step of the process. - `workflow` (array) Another nested workflow. Example: ["http://example.org/Profile"] ## Response 401 fields (application/json): - `message` (string, required) Error message indicating unauthorized access. Example: "Unauthorized" - `statusCode` (number, required) HTTP status code for unauthorized access. Example: 401 ## Response 400 fields ## Response 404 fields