FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageopenehr.base
Resource TypeStructureDefinition
IdStructureDefinition-EXTRACT-REQUEST.json
FHIR VersionR5
Sourcehttps://build.fhir.org/ig/openehr-fhir/base-spec/StructureDefinition-EXTRACT-REQUEST.html
URLhttp://openehr.org/fhir/StructureDefinition/EXTRACT_REQUEST
Version0.1.0
Statusactive
Date2025-09-06T15:35:39+10:00
NameEXTRACT_REQUEST
TitleEXTRACT_REQUEST
Realmuv
Authorityhl7
DescriptionGeneric model of a Request for an Extract, containing an Extract specification.
Typehttp://openehr.org/fhir/StructureDefinition/EXTRACT_REQUEST
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
openehr.base#currentEXTRACT_SPECEXTRACT_SPEC
openehr.base#currentEXTRACT_UPDATE_SPECEXTRACT_UPDATE_SPEC
openehr.base#currentHIER_OBJECT_IDHIER_OBJECT_ID
openehr.base#currentLOCATABLELOCATABLE

Narrative

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

Generated Narrative: StructureDefinition EXTRACT-REQUEST

NameFlagsCard.TypeDescription & Constraintsdoco
.. EXTRACT_REQUEST 0..*LOCATABLEGeneric model of a Request for an Extract, containing an Extract specification.

Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit
... extract_spec 1..1EXTRACT_SPECSpecification details of the request.
... update_spec 0..1EXTRACT_UPDATE_SPECUpdate details of the request.
... uid 1..1HIER_OBJECT_IDIdentifier of this Request, generated by requestor.

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "EXTRACT-REQUEST",
  "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_REQUEST",
  "version": "0.1.0",
  "name": "EXTRACT_REQUEST",
  "title": "EXTRACT_REQUEST",
  "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 a Request for an Extract, containing an Extract specification.",
  "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_REQUEST",
  "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_REQUEST",
        "path": "EXTRACT_REQUEST",
        "short": "Generic model of a Request for an Extract, containing an Extract specification.",
        "definition": "Generic model of a Request for an Extract, containing an Extract specification.",
        "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"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "EXTRACT_REQUEST.name",
        "path": "EXTRACT_REQUEST.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_REQUEST.archetype-node-id",
        "path": "EXTRACT_REQUEST.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_REQUEST.uid",
        "path": "EXTRACT_REQUEST.uid",
        "short": "Identifier of this Request, generated by requestor.",
        "definition": "Identifier of this Request, generated by requestor.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "LOCATABLE.uid",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID"
          }
        ],
        "isModifier": false
      },
      {
        "id": "EXTRACT_REQUEST.links",
        "path": "EXTRACT_REQUEST.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_REQUEST.archetype-details",
        "path": "EXTRACT_REQUEST.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_REQUEST.feeder-audit",
        "path": "EXTRACT_REQUEST.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_REQUEST.extract-spec",
        "path": "EXTRACT_REQUEST.extract_spec",
        "short": "Specification details of the request.",
        "definition": "Specification details of the request.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "EXTRACT_REQUEST.extract_spec",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_SPEC"
          }
        ],
        "isModifier": false
      },
      {
        "id": "EXTRACT_REQUEST.update-spec",
        "path": "EXTRACT_REQUEST.update_spec",
        "short": "Update details of the request.",
        "definition": "Update details of the request.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EXTRACT_REQUEST.update_spec",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_UPDATE_SPEC"
          }
        ],
        "isModifier": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "EXTRACT_REQUEST",
        "path": "EXTRACT_REQUEST",
        "short": "Generic model of a Request for an Extract, containing an Extract specification.",
        "definition": "Generic model of a Request for an Extract, containing an Extract specification.",
        "min": 0,
        "max": "*",
        "isModifier": false
      },
      {
        "id": "EXTRACT_REQUEST.extract-spec",
        "path": "EXTRACT_REQUEST.extract_spec",
        "short": "Specification details of the request.",
        "definition": "Specification details of the request.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_SPEC"
          }
        ],
        "isModifier": false
      },
      {
        "id": "EXTRACT_REQUEST.update-spec",
        "path": "EXTRACT_REQUEST.update_spec",
        "short": "Update details of the request.",
        "definition": "Update details of the request.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/EXTRACT_UPDATE_SPEC"
          }
        ],
        "isModifier": false
      },
      {
        "id": "EXTRACT_REQUEST.uid",
        "path": "EXTRACT_REQUEST.uid",
        "short": "Identifier of this Request, generated by requestor.",
        "definition": "Identifier of this Request, generated by requestor.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "http://openehr.org/fhir/StructureDefinition/HIER_OBJECT_ID"
          }
        ],
        "isModifier": false
      }
    ]
  }
}