FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/ACTION

Packageopenehr.base
TypeStructureDefinition
IdACTION
FHIR VersionR5
Sourcehttp://openehr.org/fhir/https://build.fhir.org/ig/FHIR/openehr-base-ig/StructureDefinition-ACTION.html
URLhttp://openehr.org/fhir/StructureDefinition/ACTION
Version0.1.0
Statusactive
Date2024-12-31T18:45:58+10:00
NameACTION
TitleACTION
Realmuv
Authorityhl7
DescriptionUsed to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another.
Typehttp://openehr.org/fhir/StructureDefinition/ACTION
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
CARE-ENTRYCARE_ENTRY
DV-DATE-TIMEDV_DATE_TIME
INSTRUCTION-DETAILSINSTRUCTION_DETAILS
ISM-TRANSITIONISM_TRANSITION
ITEM-STRUCTUREITEM_STRUCTURE

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition ACTION

NameFlagsCard.TypeDescription & Constraintsdoco
.. ACTION 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 record a clinical action that has been performed
... time 1..1DV_DATE_TIMEPoint in time at which this action completed
... ism_transition 1..1ISM_TRANSITIONDetails of transition in the Instruction state machine caused by this Action
... instruction_details 0..1INSTRUCTION_DETAILSDetails of the Instruction that caused this Action to be performed, if there was one
... description 1..1ITEM_STRUCTUREDescription of the action that has been performed, in the form of an archetyped structure

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "ACTION",
  "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#_action_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/ACTION",
  "version": "0.1.0",
  "name": "ACTION",
  "title": "ACTION",
  "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 record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another.",
  "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/ACTION",
  "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": "ACTION",
        "path": "ACTION",
        "short": "Used to record a clinical action that has been performed",
        "definition": "Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another.",
        "comment": "An ENTRY is also the minimal unit of information any query should return, since a whole ENTRY (including subparts) records spatial structure, timing information, and contextual information, as well as the subject and generator of the information.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "ACTION.name",
        "path": "ACTION.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": "ACTION.archetype-node-id",
        "path": "ACTION.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": "ACTION.uid",
        "path": "ACTION.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": "ACTION.links",
        "path": "ACTION.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": "ACTION.archetype-details",
        "path": "ACTION.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": "ACTION.feeder-audit",
        "path": "ACTION.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": "ACTION.language",
        "path": "ACTION.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": "ACTION.encoding",
        "path": "ACTION.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": "ACTION.other-participations",
        "path": "ACTION.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": "ACTION.workflow-id",
        "path": "ACTION.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": "ACTION.subject",
        "path": "ACTION.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": "ACTION.provider",
        "path": "ACTION.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": "ACTION.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": "ACTION.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": "ACTION.guideline-id",
        "path": "ACTION.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": "ACTION.time",
        "path": "ACTION.time",
        "short": "Point in time at which this action completed",
        "definition": "Point in time at which this action completed. To indicate an unknown time, use a DV_DATE_TIME instance with value set to the time of creation (or some other known time before which the Action is known to have occurred, e.g. data accession timestamp from integration engine), and magnitude_status set to <.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ACTION.time",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ACTION.ism-transition",
        "path": "ACTION.ism_transition",
        "short": "Details of transition in the Instruction state machine caused by this Action",
        "definition": "Details of transition in the Instruction state machine caused by this Action.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ACTION.ism_transition",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ISM-TRANSITION"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ACTION.instruction-details",
        "path": "ACTION.instruction_details",
        "short": "Details of the Instruction that caused this Action to be performed, if there was one",
        "definition": "Details of the Instruction that caused this Action to be performed, if there was one.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ACTION.instruction_details",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/INSTRUCTION-DETAILS"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ACTION.description",
        "path": "ACTION.description",
        "short": "Description of the action that has been performed, in the form of an archetyped structure",
        "definition": "Description of the action that has been performed, in the form of an archetyped structure.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ACTION.description",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ACTION",
        "path": "ACTION",
        "short": "Used to record a clinical action that has been performed",
        "definition": "Used to record a clinical action that has been performed, which may have been ad hoc, or due to the execution of an Activity in an Instruction workflow. Every Action corresponds to a careflow step of some kind or another.",
        "min": 0,
        "max": "*",
        "isModifier": false
      },
      {
        "id": "ACTION.time",
        "path": "ACTION.time",
        "short": "Point in time at which this action completed",
        "definition": "Point in time at which this action completed. To indicate an unknown time, use a DV_DATE_TIME instance with value set to the time of creation (or some other known time before which the Action is known to have occurred, e.g. data accession timestamp from integration engine), and magnitude_status set to <.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ACTION.ism-transition",
        "path": "ACTION.ism_transition",
        "short": "Details of transition in the Instruction state machine caused by this Action",
        "definition": "Details of transition in the Instruction state machine caused by this Action.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ISM-TRANSITION"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ACTION.instruction-details",
        "path": "ACTION.instruction_details",
        "short": "Details of the Instruction that caused this Action to be performed, if there was one",
        "definition": "Details of the Instruction that caused this Action to be performed, if there was one.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/INSTRUCTION-DETAILS"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ACTION.description",
        "path": "ACTION.description",
        "short": "Description of the action that has been performed, in the form of an archetyped structure",
        "definition": "Description of the action that has been performed, in the form of an archetyped structure.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"
          }
        ],
        "isModifier": false
      }
    ]
  }
}