FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

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

Generated Narrative: StructureDefinition LOCATABLE

Name	Flags	Card.	Type	Description & Constraints
LOCATABLE	C	0..*	PATHABLE	This is an abstract type. Child types: ACTIVITY, ADDRESS, CAPABILITY, COMPOSITION, CONTACT, CONTENT_ITEM, DATA_STRUCTURE, EHR_ACCESS, EHR_STATUS, EVENT, EXTRACT_ACTION_REQUEST, EXTRACT_CHAPTER, EXTRACT_ITEM, EXTRACT_REQUEST, EXTRACT, FOLDER, ITEM, PARTY_IDENTITY, PARTY_RELATIONSHIP, PARTY Root class of all information model classes that can be archetyped. Constraints: Links_valid, Archetyped_valid, Archetype_node_id_valid
name		1..1	DV_TEXT	Runtime name of this fragment, used to build runtime paths.
archetype_node_id		1..1	string	Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.
uid		0..1	UID_BASED_ID	Optional globally unique object identifier for root points of archetyped structures.
links		0..*	LINK	Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).
archetype_details		0..1	ARCHETYPED	Details of archetyping used on this node.
feeder_audit		0..1	FEEDER_AUDIT	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.
Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "LOCATABLE",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "contained": [
    {
      "resourceType": "OperationDefinition",
      "id": "concept",
      "name": "concept",
      "title": "concept",
      "status": "active",
      "kind": "operation",
      "description": "Clinical concept of the archetype as a whole (= derived from the archetype_node_id' of the root node) ",
      "code": "concept",
      "system": false,
      "instance": true,
      "parameter": [
        {
          "name": "return",
          "use": "out",
          "min": 1,
          "max": "1",
          "type": "string"
        }
      ]
    },
    {
      "resourceType": "OperationDefinition",
      "id": "is_archetype_root",
      "name": "is_archetype_root",
      "title": "is_archetype_root",
      "status": "active",
      "kind": "operation",
      "description": "True if this node is the root of an archetyped structure.",
      "code": "is_archetype_root",
      "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/common.html#_locatable_class"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#concept"
    },
    {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
      "valueCanonical": "#is_archetype_root"
    },
    {
      "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/LOCATABLE",
  "version": "0.1.0-snapshot",
  "name": "LOCATABLE",
  "title": "LOCATABLE",
  "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": "Root class of all information model classes that can be archetyped. Most classes in the openEHR reference model inherit from the `LOCATABLE` class, which defines the idea of  locatability in an archetyped structure. `LOCATABLE` defines a runtime name and an `_archetype_node_id_`. ",
  "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/LOCATABLE",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/PATHABLE",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0-snapshot"
      }
    ],
    "element": [
      {
        "id": "LOCATABLE",
        "path": "LOCATABLE",
        "short": "Root class of all information model classes that can be archetyped.",
        "definition": "Root class of all information model classes that can be archetyped. Most classes in the openEHR reference model inherit from the `LOCATABLE` class, which defines the idea of  locatability in an archetyped structure. `LOCATABLE` defines a runtime name and an `_archetype_node_id_`. ",
        "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()"
          },
          {
            "key": "Archetyped_valid",
            "severity": "error",
            "human": "Archetyped valid must satisfy exclusive conditions",
            "expression": "is_archetype_root() xor archetype_details .empty()"
          },
          {
            "key": "Archetype_node_id_valid",
            "severity": "error",
            "human": "Archetype node id valid must not be empty",
            "expression": "archetype_node_id.empty().not()"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "LOCATABLE.name",
        "path": "LOCATABLE.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": "LOCATABLE.archetype-node-id",
        "path": "LOCATABLE.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": "LOCATABLE.uid",
        "path": "LOCATABLE.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": "LOCATABLE.links",
        "path": "LOCATABLE.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": "LOCATABLE.archetype-details",
        "path": "LOCATABLE.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": "LOCATABLE.feeder-audit",
        "path": "LOCATABLE.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
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "LOCATABLE",
        "path": "LOCATABLE",
        "short": "Root class of all information model classes that can be archetyped.",
        "definition": "Root class of all information model classes that can be archetyped. Most classes in the openEHR reference model inherit from the `LOCATABLE` class, which defines the idea of  locatability in an archetyped structure. `LOCATABLE` defines a runtime name and an `_archetype_node_id_`. ",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "Links_valid",
            "severity": "error",
            "human": "Links valid must be present",
            "expression": "links.exists() implies links.empty().not()"
          },
          {
            "key": "Archetyped_valid",
            "severity": "error",
            "human": "Archetyped valid must satisfy exclusive conditions",
            "expression": "is_archetype_root() xor archetype_details .empty()"
          },
          {
            "key": "Archetype_node_id_valid",
            "severity": "error",
            "human": "Archetype node id valid must not be empty",
            "expression": "archetype_node_id.empty().not()"
          }
        ],
        "isModifier": false
      },
      {
        "id": "LOCATABLE.name",
        "path": "LOCATABLE.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. \n",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
          }
        ],
        "isModifier": false
      },
      {
        "id": "LOCATABLE.archetype-node-id",
        "path": "LOCATABLE.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. \n",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false
      },
      {
        "id": "LOCATABLE.uid",
        "path": "LOCATABLE.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",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
          }
        ],
        "isModifier": false
      },
      {
        "id": "LOCATABLE.links",
        "path": "LOCATABLE.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": "*",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/LINK"
          }
        ],
        "isModifier": false
      },
      {
        "id": "LOCATABLE.archetype-details",
        "path": "LOCATABLE.archetype_details",
        "short": "Details of archetyping used on this node.",
        "definition": "Details of archetyping used on this node.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
          }
        ],
        "isModifier": false
      },
      {
        "id": "LOCATABLE.feeder-audit",
        "path": "LOCATABLE.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",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
          }
        ],
        "isModifier": false
      }
    ]
  }
}