FHIR IG analytics| Package | openehr.base |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-EXTRACT.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/openehr-fhir/base-spec/StructureDefinition-EXTRACT.html |
| URL | http://openehr.org/fhir/StructureDefinition/EXTRACT |
| Version | 0.1.0 |
| Status | active |
| Date | 2025-09-06T15:35:39+10:00 |
| Name | EXTRACT |
| Title | EXTRACT |
| Realm | uv |
| Authority | hl7 |
| Description | Generic model of an Extract of some information from a repository. |
| Type | http://openehr.org/fhir/StructureDefinition/EXTRACT |
| Kind | logical |
No resources found
| StructureDefinition | ||
| openehr.base#current | DV_DATE_TIME | DV_DATE_TIME |
| openehr.base#current | EXTRACT_CHAPTER | EXTRACT_CHAPTER |
| openehr.base#current | EXTRACT_PARTICIPATION | EXTRACT_PARTICIPATION |
| openehr.base#current | EXTRACT_SPEC | EXTRACT_SPEC |
| openehr.base#current | HIER_OBJECT_ID | HIER_OBJECT_ID |
| openehr.base#current | LOCATABLE | LOCATABLE |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition EXTRACT
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EXTRACT | C | 0..* | LOCATABLE | Generic model of an Extract of some information from a repository. Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit Constraints: sequence-nr-valid |
  chapters | 0..* | EXTRACT_CHAPTER | The content extracted and serialised from the source repository for this Extract. | |
| specification | 0..1 | EXTRACT_SPEC | The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request. | |
| request_id | 0..1 | HIER_OBJECT_ID | Reference to causing Request, if any. | |
| time_created | 1..1 | DV_DATE_TIME | Creation time of this Extract | |
| system_id | 1..1 | HIER_OBJECT_ID | Identifier of creating system. | |
 sequence_nr | 1..1 | integer | Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`. | |
 participations | 0..* | EXTRACT_PARTICIPATION | Participations relevant to the creation of this Extract. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "EXTRACT",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/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/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/EXTRACT",
"version": "0.1.0",
"name": "EXTRACT",
"title": "EXTRACT",
"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": "Generic model of an Extract of some information from a repository.",
"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/EXTRACT",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/LOCATABLE",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0"
}
],
"element": [
{
"id": "EXTRACT",
"path": "EXTRACT",
"short": "Generic model of an Extract of some information from a repository.",
"definition": "Generic model of an Extract of some information from a repository.",
"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": "sequence-nr-valid",
"severity": "error",
"human": "Sequence nr valid must satisfy range constraints",
"expression": "{} // : manual translation needed"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EXTRACT.name",
"path": "EXTRACT.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": "EXTRACT.archetype-node-id",
"path": "EXTRACT.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": "EXTRACT.uid",
"path": "EXTRACT.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": "EXTRACT.links",
"path": "EXTRACT.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": "EXTRACT.archetype-details",
"path": "EXTRACT.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": "EXTRACT.feeder-audit",
"path": "EXTRACT.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": "EXTRACT.chapters",
"path": "EXTRACT.chapters",
"short": "The content extracted and serialised from the source repository for this Extract.",
"definition": "The content extracted and serialised from the source repository for this Extract.",
"min": 0,
"max": "*",
"base": {
"path": "EXTRACT.chapters",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_CHAPTER"
}
],
"isModifier": false
},
{
"id": "EXTRACT.specification",
"path": "EXTRACT.specification",
"short": "The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.",
"definition": "The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.",
"min": 0,
"max": "1",
"base": {
"path": "EXTRACT.specification",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_SPEC"
}
],
"isModifier": false
},
{
"id": "EXTRACT.request-id",
"path": "EXTRACT.request_id",
"short": "Reference to causing Request, if any.",
"definition": "Reference to causing Request, if any.",
"min": 0,
"max": "1",
"base": {
"path": "EXTRACT.request_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID"
}
],
"isModifier": false
},
{
"id": "EXTRACT.time-created",
"path": "EXTRACT.time_created",
"short": "Creation time of this Extract",
"definition": "Creation time of this Extract",
"min": 1,
"max": "1",
"base": {
"path": "EXTRACT.time_created",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV_DATE_TIME"
}
],
"isModifier": false
},
{
"id": "EXTRACT.system-id",
"path": "EXTRACT.system_id",
"short": "Identifier of creating system.",
"definition": "Identifier of creating system.",
"min": 1,
"max": "1",
"base": {
"path": "EXTRACT.system_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID"
}
],
"isModifier": false
},
{
"id": "EXTRACT.sequence-nr",
"path": "EXTRACT.sequence_nr",
"short": "Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.",
"definition": "Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`. If this is the sole response, or there was no request, value is 1.",
"min": 1,
"max": "1",
"base": {
"path": "EXTRACT.sequence_nr",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
],
"isModifier": false
},
{
"id": "EXTRACT.participations",
"path": "EXTRACT.participations",
"short": "Participations relevant to the creation of this Extract.",
"definition": "Participations relevant to the creation of this Extract.",
"min": 0,
"max": "*",
"base": {
"path": "EXTRACT.participations",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_PARTICIPATION"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "EXTRACT",
"path": "EXTRACT",
"short": "Generic model of an Extract of some information from a repository.",
"definition": "Generic model of an Extract of some information from a repository.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "sequence-nr-valid",
"severity": "error",
"human": "Sequence nr valid must satisfy range constraints",
"expression": "{} // : manual translation needed"
}
],
"isModifier": false
},
{
"id": "EXTRACT.chapters",
"path": "EXTRACT.chapters",
"short": "The content extracted and serialised from the source repository for this Extract.",
"definition": "The content extracted and serialised from the source repository for this Extract.",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_CHAPTER"
}
],
"isModifier": false
},
{
"id": "EXTRACT.specification",
"path": "EXTRACT.specification",
"short": "The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.",
"definition": "The specification that this Extract actually conforms to; might not be identical with the specification of the corresponding request.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_SPEC"
}
],
"isModifier": false
},
{
"id": "EXTRACT.request-id",
"path": "EXTRACT.request_id",
"short": "Reference to causing Request, if any.",
"definition": "Reference to causing Request, if any.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID"
}
],
"isModifier": false
},
{
"id": "EXTRACT.time-created",
"path": "EXTRACT.time_created",
"short": "Creation time of this Extract",
"definition": "Creation time of this Extract",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV_DATE_TIME"
}
],
"isModifier": false
},
{
"id": "EXTRACT.system-id",
"path": "EXTRACT.system_id",
"short": "Identifier of creating system.",
"definition": "Identifier of creating system.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID"
}
],
"isModifier": false
},
{
"id": "EXTRACT.sequence-nr",
"path": "EXTRACT.sequence_nr",
"short": "Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`.",
"definition": "Number of this Extract response in sequence of responses to Extract request identified by `_request_id_`. If this is the sole response, or there was no request, value is 1.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": false
},
{
"id": "EXTRACT.participations",
"path": "EXTRACT.participations",
"short": "Participations relevant to the creation of this Extract.",
"definition": "Participations relevant to the creation of this Extract.",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_PARTICIPATION"
}
],
"isModifier": false
}
]
}
}