| Package | openehr.base |
| Type | StructureDefinition |
| Id | INSTRUCTION |
| FHIR Version | R5 |
| Source | http://openehr.org/fhir/https://build.fhir.org/ig/FHIR/openehr-base-ig/StructureDefinition-INSTRUCTION.html |
| URL | http://openehr.org/fhir/StructureDefinition/INSTRUCTION |
| Version | 0.1.0 |
| Status | active |
| Date | 2024-12-31T18:45:58+10:00 |
| Name | INSTRUCTION |
| Title | INSTRUCTION |
| Realm | uv |
| Authority | hl7 |
| Description | Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms. |
| Type | http://openehr.org/fhir/StructureDefinition/INSTRUCTION |
| Kind | logical |
No resources found
| StructureDefinition | |
| ACTIVITY | ACTIVITY |
| CARE-ENTRY | CARE_ENTRY |
| DV-DATE-TIME | DV_DATE_TIME |
| DV-PARSABLE | DV_PARSABLE |
| DV-TEXT | DV_TEXT |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition INSTRUCTION
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  INSTRUCTION | 0..* | CARE_ENTRY | Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, name, archetype_node_id, uid, links, archetype_details, feeder_audit, language, encoding, other_participations, workflow_id, subject, provider, protocol, guideline_id Used to specify actions in the future | |
  narrative | 1..1 | DV_TEXT | Mandatory human-readable version of what the Instruction is about | |
| expiry_time | 0..1 | DV_DATE_TIME | Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired | |
| wf_definition | 0..1 | DV_PARSABLE | Optional workflow engine executable expression of the Instruction | |
 activities | 0..* | ACTIVITY | List of all activities in Instruction | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "INSTRUCTION",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/RM/development/ehr.html#_instruction_class"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode": "element-view-replace-cardinality"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url": "http://openehr.org/fhir/StructureDefinition/INSTRUCTION",
"version": "0.1.0",
"name": "INSTRUCTION",
"title": "INSTRUCTION",
"status": "active",
"experimental": false,
"date": "2024-12-31T18:45:58+10:00",
"publisher": "openEHR + HL7",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.openehr.org"
}
]
}
],
"description": "Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://openehr.org/fhir/StructureDefinition/INSTRUCTION",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/CARE-ENTRY",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0"
}
],
"element": [
{
"id": "INSTRUCTION",
"path": "INSTRUCTION",
"short": "Used to specify actions in the future",
"definition": "Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine.",
"comment": "Not to be used for plan items which are only specified in general terms.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "INSTRUCTION.name",
"path": "INSTRUCTION.name",
"short": "Runtime name of this fragment, used to build runtime paths",
"definition": "This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.",
"min": 1,
"max": "1",
"base": {
"path": "PATHABLE.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.archetype-node-id",
"path": "INSTRUCTION.archetype_node_id",
"short": "Design-time archetype identifier of this node taken from its generating archetype",
"definition": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.",
"comment": "At an archetype root point, the value of this attribute is always the stringified form of the archetype_id found in the archetype_details object.",
"min": 1,
"max": "1",
"base": {
"path": "PATHABLE.archetype_node_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.uid",
"path": "INSTRUCTION.uid",
"short": "Optional globally unique object identifier for root points of archetyped structures",
"definition": "Optional globally unique object identifier for root points of archetyped structures.",
"min": 0,
"max": "1",
"base": {
"path": "PATHABLE.uid",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.links",
"path": "INSTRUCTION.links",
"short": "Links to other archetyped structures",
"definition": "Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.",
"min": 0,
"max": "*",
"base": {
"path": "PATHABLE.links",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/LINK"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.archetype-details",
"path": "INSTRUCTION.archetype_details",
"short": "Details of archetyping used on this node",
"definition": "Details of archetyping used on this node.",
"min": 0,
"max": "1",
"base": {
"path": "PATHABLE.archetype_details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.feeder-audit",
"path": "INSTRUCTION.feeder_audit",
"short": "Audit trail from non-openEHR system of original commit of information forming the content of this node",
"definition": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
"min": 0,
"max": "1",
"base": {
"path": "PATHABLE.feeder_audit",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.language",
"path": "INSTRUCTION.language",
"short": "Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages",
"definition": "Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set languages.",
"min": 1,
"max": "1",
"base": {
"path": "ENTRY.language",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id": "INSTRUCTION.encoding",
"path": "INSTRUCTION.encoding",
"short": "Name of character set in which text values in this Entry are encoded",
"definition": "Name of character set in which text values in this Entry are encoded. Coded from openEHR Code Set character sets.",
"min": 1,
"max": "1",
"base": {
"path": "ENTRY.encoding",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "https://specifications.openehr.org/fhir/valueset-character_sets"
}
},
{
"id": "INSTRUCTION.other-participations",
"path": "INSTRUCTION.other_participations",
"short": "Other participations at ENTRY level",
"definition": "Other participations at ENTRY level.",
"min": 0,
"max": "*",
"base": {
"path": "ENTRY.other_participations",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/PARTICIPATION"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.workflow-id",
"path": "INSTRUCTION.workflow_id",
"short": "Identifier of externally held workflow engine data for this workflow execution, for this subject of care",
"definition": "Identifier of externally held workflow engine data for this workflow execution, for this subject of care.",
"min": 0,
"max": "1",
"base": {
"path": "ENTRY.workflow_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.subject",
"path": "INSTRUCTION.subject",
"short": "Id of human subject of this ENTRY, e.g. organ donor, foetus, a family member, or another clinically relevant person",
"definition": "Id of human subject of this ENTRY, e.g.:\r\n\r\n* organ donor\r\n* foetus\r\n* a family member\r\n* another clinically relevant person",
"min": 1,
"max": "1",
"base": {
"path": "ENTRY.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.provider",
"path": "INSTRUCTION.provider",
"short": "Optional identification of provider of the information in this ENTRY, which might be the patient, a patient agent, the clinician, a device",
"definition": "Optional identification of provider of the information in this ENTRY, which might be:\r\n\r\n* the patient\r\n* a patient agent, e.g. parent, guardian\r\n* the clinician\r\n* a device or software\r\n\r\n\r\nGenerally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed.",
"min": 0,
"max": "1",
"base": {
"path": "ENTRY.provider",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.protocol",
"extension": [
{
"extension": [
{
"url": "name",
"valueCode": "element-view-group"
},
{
"url": "value",
"valueString": "Protocol"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
},
{
"extension": [
{
"url": "name",
"valueCode": "element-view-order"
},
{
"url": "value",
"valueInteger": 4
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
}
],
"path": "INSTRUCTION.protocol",
"short": "Description of the method (i.e. how) the information in this entry was arrived at",
"definition": "Description of the method (i.e. how) the information in this entry was arrived at. For OBSERVATIONs, this is a description of the method or instrument used. For EVALUATIONs, how the evaluation was arrived at. For INSTRUCTIONs, how to execute the Instruction. This may take the form of references to guidelines, including manually followed and executable; knowledge references such as a paper in Medline; clinical reasons within a larger care process.",
"min": 0,
"max": "1",
"base": {
"path": "CARE_ENTRY.protocol",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.guideline-id",
"path": "INSTRUCTION.guideline_id",
"short": "Optional external identifier of guideline creating this Entry if relevant",
"definition": "Optional external identifier of guideline creating this Entry if relevant.",
"min": 0,
"max": "1",
"base": {
"path": "CARE_ENTRY.guideline_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.narrative",
"path": "INSTRUCTION.narrative",
"short": "Mandatory human-readable version of what the Instruction is about",
"definition": "Mandatory human-readable version of what the Instruction is about.",
"min": 1,
"max": "1",
"base": {
"path": "INSTRUCTION.narrative",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.expiry-time",
"path": "INSTRUCTION.expiry_time",
"short": "Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired",
"definition": "Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other.",
"min": 0,
"max": "1",
"base": {
"path": "INSTRUCTION.expiry_time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.wf-definition",
"path": "INSTRUCTION.wf_definition",
"short": "Optional workflow engine executable expression of the Instruction",
"definition": "Optional workflow engine executable expression of the Instruction.",
"min": 0,
"max": "1",
"base": {
"path": "INSTRUCTION.wf_definition",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-PARSABLE"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.activities",
"path": "INSTRUCTION.activities",
"short": "List of all activities in Instruction",
"definition": "List of all activities in Instruction.",
"min": 0,
"max": "*",
"base": {
"path": "INSTRUCTION.activities",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ACTIVITY"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "INSTRUCTION",
"path": "INSTRUCTION",
"short": "Used to specify actions in the future",
"definition": "Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine.",
"comment": "Not to be used for plan items which are only specified in general terms.",
"min": 0,
"max": "*",
"isModifier": false
},
{
"id": "INSTRUCTION.narrative",
"path": "INSTRUCTION.narrative",
"short": "Mandatory human-readable version of what the Instruction is about",
"definition": "Mandatory human-readable version of what the Instruction is about.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.expiry-time",
"path": "INSTRUCTION.expiry_time",
"short": "Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired",
"definition": "Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.wf-definition",
"path": "INSTRUCTION.wf_definition",
"short": "Optional workflow engine executable expression of the Instruction",
"definition": "Optional workflow engine executable expression of the Instruction.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-PARSABLE"
}
],
"isModifier": false
},
{
"id": "INSTRUCTION.activities",
"path": "INSTRUCTION.activities",
"short": "List of all activities in Instruction",
"definition": "List of all activities in Instruction.",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ACTIVITY"
}
],
"isModifier": false
}
]
}
}