FHIR IG Statistics: StructureDefinition/LOCATABLE

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		0..*	PATHABLE	This is an abstract type. Child types: FOLDER, PARTICIPATION, ADDRESS, CAPABILITY, CONTACT, PARTY_IDENTITY, PARTY_RELATIONSHIP, PARTY, ACTIVITY, COMPOSITION, CONTENT_ITEM, EHR_ACCESS, EHR_STATUS, EVENT_CONTEXT, DATA_STRUCTURE, EVENT, ITEM Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Root class of all information model classes that can be archetyped
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
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
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
Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "LOCATABLE",
  "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/common.html#_locatable_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/LOCATABLE",
  "version": "0.1.0",
  "name": "LOCATABLE",
  "title": "LOCATABLE",
  "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": "The LOCATABLE class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of LOCATABLE. The defining characteristics of LOCATABLE objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient.",
  "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"
      }
    ],
    "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": "*"
        },
        "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": "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": "LOCATABLE.archetype-node-id",
        "path": "LOCATABLE.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": "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": "PATHABLE.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",
        "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": "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": "PATHABLE.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",
        "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
      }
    ]
  },
  "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": "*",
        "isModifier": false
      },
      {
        "id": "LOCATABLE.name",
        "path": "LOCATABLE.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",
        "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",
        "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",
        "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",
        "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",
        "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
      }
    ]
  }
}