FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ITEM-LIST.json |
| FHIR Version | R5 |
| Source | http://fhir.org/guides/openehr/base/0.1.0-snapshot/StructureDefinition-ITEM-LIST.html |
| URL | http://openehr.org/fhir/StructureDefinition/ITEM-LIST |
| Version | 0.1.0-snapshot |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | ITEM_LIST |
| Title | ITEM_LIST |
| Realm | uv |
| Authority | hl7 |
| Description | Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. The list may be empty. `ITEM_LIST` is used to represent any data which is logically a list of values, such as blood pressure, most protocols, many blood tests etc. Not to be used for time-based lists, which should be represented with the proper temporal class, i.e. `HISTORY`. |
| Type | http://openehr.org/fhir/StructureDefinition/ITEM_LIST |
| Kind | logical |
No resources found
| StructureDefinition | ||
| openehr.base#0.1.0-snapshot | ELEMENT | ELEMENT |
| openehr.base#0.1.0-snapshot | ITEM-STRUCTURE | ITEM_STRUCTURE |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ITEM-LIST
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ITEM_LIST | C | 0..* | ITEM_STRUCTURE | Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: Valid_structure |
  items | 0..* | ELEMENT | Physical representation of the list. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ITEM-LIST",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"contained": [
{
"resourceType": "OperationDefinition",
"id": "item_count",
"name": "item_count",
"title": "item_count",
"status": "active",
"kind": "operation",
"description": "Count of all items.",
"code": "item_count",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "integer"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "names",
"name": "names",
"title": "names",
"status": "active",
"kind": "operation",
"description": "Retrieve the names of all items.",
"code": "names",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "string"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "named_item",
"name": "named_item",
"title": "named_item",
"status": "active",
"kind": "operation",
"description": "Retrieve the item with name ‘a_name’.",
"code": "named_item",
"system": false,
"instance": true,
"parameter": [
{
"name": "a_name",
"use": "in",
"min": 1,
"max": "1",
"type": "string"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "Parameters"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "ith_item",
"name": "ith_item",
"title": "ith_item",
"status": "active",
"kind": "operation",
"description": "Retrieve the i-th item with name.",
"code": "ith_item",
"system": false,
"instance": true,
"parameter": [
{
"name": "i",
"use": "in",
"min": 1,
"max": "1",
"type": "integer"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "Parameters"
}
]
},
{
"resourceType": "OperationDefinition",
"id": "as_hierarchy",
"name": "as_hierarchy",
"title": "as_hierarchy",
"status": "active",
"kind": "operation",
"description": "Generate a CEN EN13606-compatible hierarchy consisting of a single `CLUSTER` containing the `ELEMENTs` of this list.",
"code": "as_hierarchy",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"type": "Parameters"
}
]
}
],
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/RM/Release-1.1.0/data_structures.html#_item_list_class"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#item_count"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#names"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#named_item"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#ith_item"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical": "#as_hierarchy"
},
{
"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/ITEM-LIST",
"version": "0.1.0-snapshot",
"name": "ITEM_LIST",
"title": "ITEM_LIST",
"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": "Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. The list may be empty. \n\n`ITEM_LIST` is used to represent any data which is logically a list of values, such as blood pressure, most protocols, many blood tests etc. \n\nNot to be used for time-based lists, which should be represented with the proper temporal class, i.e. `HISTORY`.",
"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/ITEM_LIST",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0-snapshot"
}
],
"element": [
{
"id": "ITEM_LIST",
"path": "ITEM_LIST",
"short": "Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list.",
"definition": "Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. The list may be empty. \n\n`ITEM_LIST` is used to represent any data which is logically a list of values, such as blood pressure, most protocols, many blood tests etc. \n\nNot to be used for time-based lists, which should be represented with the proper temporal class, i.e. `HISTORY`.",
"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": "Valid_structure",
"severity": "error",
"human": "Valid structure",
"expression": " items.forall (i:ITEM | i.type() = \\\"ELEMENT\\\")"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ITEM_LIST.name",
"path": "ITEM_LIST.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": "ITEM_LIST.archetype-node-id",
"path": "ITEM_LIST.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": "ITEM_LIST.uid",
"path": "ITEM_LIST.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": "ITEM_LIST.links",
"path": "ITEM_LIST.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": "ITEM_LIST.archetype-details",
"path": "ITEM_LIST.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": "ITEM_LIST.feeder-audit",
"path": "ITEM_LIST.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": "ITEM_LIST.items",
"path": "ITEM_LIST.items",
"short": "Physical representation of the list.",
"definition": "Physical representation of the list.",
"min": 0,
"max": "*",
"base": {
"path": "ITEM_LIST.items",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ELEMENT"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "ITEM_LIST",
"path": "ITEM_LIST",
"short": "Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list.",
"definition": "Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. The list may be empty. \n\n`ITEM_LIST` is used to represent any data which is logically a list of values, such as blood pressure, most protocols, many blood tests etc. \n\nNot to be used for time-based lists, which should be represented with the proper temporal class, i.e. `HISTORY`.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "Valid_structure",
"severity": "error",
"human": "Valid structure",
"expression": " items.forall (i:ITEM | i.type() = \\\"ELEMENT\\\")"
}
],
"isModifier": false
},
{
"id": "ITEM_LIST.items",
"path": "ITEM_LIST.items",
"short": "Physical representation of the list.",
"definition": "Physical representation of the list. ",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ELEMENT"
}
],
"isModifier": false
}
]
}
}