FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-ENTRY.json
FHIR VersionR5
Sourcehttp://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-ENTRY.html
URLhttp://openehr.org/fhir/StructureDefinition/ENTRY
Version0.1.0-snapshot
Statusactive
Date2025-09-06T15:35:39+10:00
NameENTRY
TitleENTRY
Realmuv
Authorityhl7
DescriptionThe abstract parent of all `ENTRY` subtypes. An `ENTRY` is the root of a logical item of hard clinical information created in the clinical statement context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition. 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.
Typehttp://openehr.org/fhir/StructureDefinition/ENTRY
Kindlogical

Resources that use this resource

StructureDefinition
openehr.base#0.1.0-snapshotADMIN-ENTRYADMIN_ENTRY
openehr.base#0.1.0-snapshotCARE-ENTRYCARE_ENTRY

Resources that this resource uses

StructureDefinition
openehr.base#0.1.0-snapshotCODE-PHRASECODE_PHRASE
openehr.base#0.1.0-snapshotCONTENT-ITEMCONTENT_ITEM
openehr.base#0.1.0-snapshotOBJECT-REFOBJECT_REF
openehr.base#0.1.0-snapshotPARTICIPATIONPARTICIPATION
openehr.base#0.1.0-snapshotPARTY-PROXYPARTY_PROXY
ValueSet
openehr.base#0.1.0-snapshotvalueset-character_setsCharacter Set

Narrative

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

Generated Narrative: StructureDefinition ENTRY

NameFlagsCard.TypeDescription & Constraintsdoco
.. ENTRY C0..*CONTENT_ITEMThis is an abstract type. Child types: ADMIN_ENTRY, CARE_ENTRY
The abstract parent of all `ENTRY` subtypes.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
Binding: Character Set (required)
Constraints: Subject_validity, Other_participations_valid, Is_archetype_root
... language 1..1CODE_PHRASEMandatory indicator of the localised language in which this Entry is written.
... encoding 1..1CODE_PHRASEName of character set in which text values in this Entry are encoded.
... other_participations 0..*PARTICIPATIONOther participations at `ENTRY` level.
... workflow_id 0..1OBJECT_REFIdentifier of externally held workflow engine data for this workflow execution, for this subject of care.
... subject 1..1PARTY_PROXYId of human subject of this `ENTRY`, e.
... provider 0..1PARTY_PROXYOptional identification of provider of the information in this `ENTRY`, which might be: * the patient * a patient agent, e.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "ENTRY",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "OperationDefinition",
      "id": "subject_is_self",
      "name": "subject_is_self",
      "title": "subject_is_self",
      "status": "active",
      "kind": "operation",
      "description": "Returns True if this Entry is about the subject of the EHR, in which case the subject attribute is of type PARTY_SELF.",
      "code": "subject_is_self",
      "system": false,
      "instance": true,
      "parameter": [
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "boolean"
        }
      ]
    }
  ],
  "extension": [
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
      "valueUrl": "https://specifications.openehr.org/releases/RM/development/ehr.html#_entry_class"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#subject_is_self"
    },
    {
      "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/ENTRY",
  "version": "0.1.0-snapshot",
  "name": "ENTRY",
  "title": "ENTRY",
  "status": "active",
  "experimental": false,
  "date": "2025-09-06T15:35:39+10:00",
  "publisher": "openEHR + HL7",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.openehr.org"
        }
      ]
    }
  ],
  "description": "The abstract parent of all `ENTRY` subtypes. An `ENTRY` is the root of a logical item of  hard  clinical information created in the  clinical statement  context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition.\n\nAn `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. ",
  "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": true,
  "type": "http://openehr.org/fhir/StructureDefinition/ENTRY",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0-snapshot"
      }
    ],
    "element": [
      {
        "id": "ENTRY",
        "path": "ENTRY",
        "short": "The abstract parent of all `ENTRY` subtypes.",
        "definition": "The abstract parent of all `ENTRY` subtypes. An `ENTRY` is the root of a logical item of  hard  clinical information created in the  clinical statement  context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition.\n\nAn `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": "*"
        },
        "constraint": [
          {
            "key": "Links_valid",
            "severity": "error",
            "human": "Links valid must be present",
            "expression": "links.exists() implies links.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Archetyped_valid",
            "severity": "error",
            "human": "Archetyped valid must satisfy exclusive conditions",
            "expression": "is_archetype_root() xor archetype_details .empty()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Archetype_node_id_valid",
            "severity": "error",
            "human": "Archetype node id valid must not be empty",
            "expression": "archetype_node_id.empty().not()",
            "source": "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
          },
          {
            "key": "Subject_validity",
            "severity": "error",
            "human": "Subject validity must satisfy conditional constraints",
            "expression": "subject_is_self() implies subject.generating_type = “PARTY_SELF”"
          },
          {
            "key": "Other_participations_valid",
            "severity": "error",
            "human": "Other participations valid must be present",
            "expression": "other_participations.exists() implies other_participations.empty().not()"
          },
          {
            "key": "Is_archetype_root",
            "severity": "error",
            "human": "Is archetype root",
            "expression": "is_archetype_root()"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "ENTRY.name",
        "path": "ENTRY.name",
        "short": "Runtime name of this fragment, used to build runtime paths.",
        "definition": "Runtime name of this fragment, used to build runtime paths. 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": "LOCATABLE.name",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.archetype-node-id",
        "path": "ENTRY.archetype_node_id",
        "short": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.",
        "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. \n\nAt 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": "LOCATABLE.archetype_node_id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.uid",
        "path": "ENTRY.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": "LOCATABLE.uid",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.links",
        "path": "ENTRY.links",
        "short": "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).",
        "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": "LOCATABLE.links",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/LINK"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.archetype-details",
        "path": "ENTRY.archetype_details",
        "short": "Details of archetyping used on this node.",
        "definition": "Details of archetyping used on this node.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "LOCATABLE.archetype_details",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.feeder-audit",
        "path": "ENTRY.feeder_audit",
        "short": "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.",
        "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": "LOCATABLE.feeder_audit",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.language",
        "path": "ENTRY.language",
        "short": "Mandatory indicator of the localised language in which this Entry is written.",
        "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
      },
      {
        "id": "ENTRY.encoding",
        "path": "ENTRY.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
      },
      {
        "id": "ENTRY.other-participations",
        "path": "ENTRY.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": "ENTRY.workflow-id",
        "path": "ENTRY.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": "ENTRY.subject",
        "path": "ENTRY.subject",
        "short": "Id of human subject of this `ENTRY`, e.",
        "definition": "Id of human subject of this `ENTRY`, e.g.: \n\n* organ donor \n* foetus \n* a family member \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": "ENTRY.provider",
        "path": "ENTRY.provider",
        "short": "Optional identification of provider of the information in this `ENTRY`, which might be: \n\n* the patient \n* a patient agent, e.",
        "definition": "Optional identification of provider of the information in this `ENTRY`, which might be: \n\n* the patient \n* a patient agent, e.g. parent, guardian \n* the clinician \n* a device or software \n\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
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ENTRY",
        "path": "ENTRY",
        "short": "The abstract parent of all `ENTRY` subtypes.",
        "definition": "The abstract parent of all `ENTRY` subtypes. An `ENTRY` is the root of a logical item of  hard  clinical information created in the  clinical statement  context, within a clinical session. There can be numerous such contexts in a clinical session. Observations and other Entry types only ever document information captured/created in the event documented by the enclosing Composition.\n\nAn `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": "*",
        "constraint": [
          {
            "key": "Subject_validity",
            "severity": "error",
            "human": "Subject validity must satisfy conditional constraints",
            "expression": "subject_is_self() implies subject.generating_type = “PARTY_SELF”"
          },
          {
            "key": "Other_participations_valid",
            "severity": "error",
            "human": "Other participations valid must be present",
            "expression": "other_participations.exists() implies other_participations.empty().not()"
          },
          {
            "key": "Is_archetype_root",
            "severity": "error",
            "human": "Is archetype root",
            "expression": "is_archetype_root()"
          }
        ],
        "isModifier": false,
        "binding": {
          "strength": "required",
          "valueSet": "https://specifications.openehr.org/fhir/valueset-character_sets"
        }
      },
      {
        "id": "ENTRY.language",
        "path": "ENTRY.language",
        "short": "Mandatory indicator of the localised language in which this Entry is written.",
        "definition": "Mandatory indicator of the localised language in which this Entry is written. Coded from openEHR Code Set  languages . ",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.encoding",
        "path": "ENTRY.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",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.other-participations",
        "path": "ENTRY.other_participations",
        "short": "Other participations at `ENTRY` level.",
        "definition": "Other participations at `ENTRY` level. ",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTICIPATION"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.workflow-id",
        "path": "ENTRY.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",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.subject",
        "path": "ENTRY.subject",
        "short": "Id of human subject of this `ENTRY`, e.",
        "definition": "Id of human subject of this `ENTRY`, e.g.: \n\n* organ donor \n* foetus \n* a family member \n* another clinically relevant person.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
          }
        ],
        "isModifier": false
      },
      {
        "id": "ENTRY.provider",
        "path": "ENTRY.provider",
        "short": "Optional identification of provider of the information in this `ENTRY`, which might be: \n\n* the patient \n* a patient agent, e.",
        "definition": "Optional identification of provider of the information in this `ENTRY`, which might be: \n\n* the patient \n* a patient agent, e.g. parent, guardian \n* the clinician \n* a device or software \n\nGenerally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed. \n",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
          }
        ],
        "isModifier": false
      }
    ]
  }
}