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

FHIR IG Statistics: StructureDefinition/PATHABLE

Packageopenehr.base
TypeStructureDefinition
IdPATHABLE
FHIR VersionR5
Sourcehttp://openehr.org/fhir/https://build.fhir.org/ig/FHIR/openehr-base-ig/StructureDefinition-PATHABLE.html
URLhttp://openehr.org/fhir/StructureDefinition/PATHABLE
Version0.1.0
Statusactive
Date2024-12-31T18:45:58+10:00
NamePATHABLE
TitlePATHABLE
Realmuv
Authorityhl7
DescriptionThe PATHABLE class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of PATHABLE. The defining characteristics of PATHABLE 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.
Typehttp://openehr.org/fhir/StructureDefinition/PATHABLE
Kindlogical

Resources that use this resource

StructureDefinition
INSTRUCTION-DETAILSINSTRUCTION_DETAILS
ISM-TRANSITIONISM_TRANSITION
LOCATABLELOCATABLE

Resources that this resource uses

StructureDefinition
ARCHETYPEDARCHETYPED
AnyAny
DV-TEXTDV_TEXT
FEEDER-AUDITFEEDER_AUDIT
LINKLINK
UID-BASED-IDUID_BASED_ID

Narrative

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

Generated Narrative: StructureDefinition PATHABLE

NameFlagsCard.TypeDescription & Constraintsdoco
.. PATHABLE 0..*AnyThis is an abstract type. Child types: LOCATABLE, INSTRUCTION_DETAILS, ISM_TRANSITION
Root class of all information model classes that can be archetyped
... name 1..1DV_TEXTRuntime name of this fragment, used to build runtime paths
... archetype_node_id 1..1stringDesign-time archetype identifier of this node taken from its generating archetype
... uid 0..1UID_BASED_IDOptional globally unique object identifier for root points of archetyped structures
... links 0..*LINKLinks to other archetyped structures
... archetype_details 0..1ARCHETYPEDDetails of archetyping used on this node
... feeder_audit 0..1FEEDER_AUDITAudit trail from non-openEHR system of original commit of information forming the content of this node

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "PATHABLE",
  "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#_pathable_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/PATHABLE",
  "version": "0.1.0",
  "name": "PATHABLE",
  "title": "PATHABLE",
  "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 PATHABLE class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of PATHABLE. The defining characteristics of PATHABLE 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/PATHABLE",
  "baseDefinition": "http://openehr.org/fhir/StructureDefinition/Any",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.1.0"
      }
    ],
    "element": [
      {
        "id": "PATHABLE",
        "path": "PATHABLE",
        "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 PATHABLE class, which defines the idea of locatability in an archetyped structure. PATHABLE 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": "PATHABLE.name",
        "path": "PATHABLE.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": "PATHABLE.archetype-node-id",
        "path": "PATHABLE.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": "PATHABLE.uid",
        "path": "PATHABLE.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": "PATHABLE.links",
        "path": "PATHABLE.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": "PATHABLE.archetype-details",
        "path": "PATHABLE.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": "PATHABLE.feeder-audit",
        "path": "PATHABLE.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": "PATHABLE",
        "path": "PATHABLE",
        "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 PATHABLE class, which defines the idea of locatability in an archetyped structure. PATHABLE defines a runtime name and an archetype_node_id.",
        "min": 0,
        "max": "*",
        "isModifier": false
      },
      {
        "id": "PATHABLE.name",
        "path": "PATHABLE.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": "PATHABLE.archetype-node-id",
        "path": "PATHABLE.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": "PATHABLE.uid",
        "path": "PATHABLE.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": "PATHABLE.links",
        "path": "PATHABLE.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": "PATHABLE.archetype-details",
        "path": "PATHABLE.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": "PATHABLE.feeder-audit",
        "path": "PATHABLE.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
      }
    ]
  }
}