Generated Narrative: StructureDefinition EXTRACT-SPEC

NameFlagsCard.TypeDescription & Constraintsdoco
.. EXTRACT_SPEC 0..*AnySpecification of an Extract's contents.
... version_spec 0..1EXTRACT_VERSION_SPECSpecification of which versions of information items to include in the Extract.
... manifest 1..1EXTRACT_MANIFESTSpecification of entities (e.
... extract_type 1..1DV_CODED_TEXTCoded term indicating the type of content required, e.
... include_multimedia 1..1booleanIndicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not.
... priority 1..1integerRequested priority of this request to be handled by server.
... link_depth 1..1integerDegree of links to follow emanating from content items specified for inclusion.
... criteria 0..*DV_PARSABLEQueries specifying the contents of this Extract.
... other_details 0..1ITEM_STRUCTUREOther specification items.

doco Documentation for this format
 <status value="active"/> <experimental value="false"/> <date value="2025-09-06T15:35:39+10:00"/> <publisher value="openEHR + HL7"/> <contact> <telecom> <system value="url"/> <value value="http://www.openehr.org"/> </telecom> </contact> <description value="Specification of an Extract's contents. Subtypes can be used to add details specific to the type of Extract. The specification consists of attributes specifying the directory, and two further groups of attributes in their own classes, namely a version specfication (which versions of information items are to be included) and a manifest (which entities are to be included in the extract). Use: Used in a request to specify an Extract, as well as to describe what is contained in an Extract."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> </coding> </jurisdiction> <fhirVersion value="5.0.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="logical"/> <abstract value="false"/> <type value="http://openehr.org/fhir/StructureDefinition/EXTRACT_SPEC"/> <baseDefinition value="http://openehr.org/fhir/StructureDefinition/Any"/> <derivation value="specialization"/> <snapshot> <extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version"> <valueString value="0.1.0-snapshot"/> </extension> <element id="EXTRACT_SPEC"> <path value="EXTRACT_SPEC"/> <short value="Specification of an Extract's contents."/> <definition value="Specification of an Extract's contents. Subtypes can be used to add details specific to the type of Extract. The specification consists of attributes specifying the directory, and two further groups of attributes in their own classes, namely a version specfication (which versions of information items are to be included) and a manifest (which entities are to be included in the extract). Use: Used in a request to specify an Extract, as well as to describe what is contained in an Extract."/> <min value="0"/> <max value="*"/> <base> <path value="Base"/> <min value="0"/> <max value="*"/> </base> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="EXTRACT_SPEC.version-spec"> <path value="EXTRACT_SPEC.version_spec"/> <short value="Specification of which versions of information items to include in the Extract."/> <definition value="Specification of which versions of information items to include in the Extract. If Void, the default is latest versions only (which is reasonable for non-versioning systems as well)."/> <min value="0"/> <max value="1"/> <base> <path value="EXTRACT_SPEC.version_spec"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://openehr.org/fhir/StructureDefinition/EXTRACT-VERSION-SPEC"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.manifest"> <path value="EXTRACT_SPEC.manifest"/> <short value="Specification of entities (e."/> <definition value="Specification of entities (e.g. records) to include in the Extract."/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_SPEC.manifest"/> <min value="1"/> <max value="1"/> </base> <type> <code value="http://openehr.org/fhir/StructureDefinition/EXTRACT-MANIFEST"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.extract-type"> <path value="EXTRACT_SPEC.extract_type"/> <short value="Coded term indicating the type of content required, e."/> <definition value="Coded term indicating the type of content required, e.g. * `|openehr-ehr|` * `|openehr-demographic|` * `|generic-emr|` * `|other|` Coded by openEHR Terminology group `'extract content type'`."/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_SPEC.extract_type"/> <min value="1"/> <max value="1"/> </base> <type> <code value="http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.include-multimedia"> <path value="EXTRACT_SPEC.include_multimedia"/> <short value="Indicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not."/> <definition value="Indicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not."/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_SPEC.include_multimedia"/> <min value="1"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.priority"> <path value="EXTRACT_SPEC.priority"/> <short value="Requested priority of this request to be handled by server."/> <definition value="Requested priority of this request to be handled by server. Priority schemes are likely to be local, and use values agreed by both ends. TBD: alternative is standard coded terms"/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_SPEC.priority"/> <min value="1"/> <max value="1"/> </base> <type> <code value="integer"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.link-depth"> <path value="EXTRACT_SPEC.link_depth"/> <short value="Degree of links to follow emanating from content items specified for inclusion."/> <definition value="Degree of links to follow emanating from content items specified for inclusion. The kind of links to follow is dependent on the type of Extract. All items at the target end of followed links at the given depth are also included in the extract; `EXTRACT_CONTENT_ITEM._is_primary_` is used to differentiate. * 0 = don't follow; * 1 = follow first degree links; * 2 = follow 2nd degree links; * .... * n = follow nth degree links"/> <min value="1"/> <max value="1"/> <base> <path value="EXTRACT_SPEC.link_depth"/> <min value="1"/> <max value="1"/> </base> <type> <code value="integer"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.criteria"> <path value="EXTRACT_SPEC.criteria"/> <short value="Queries specifying the contents of this Extract."/> <definition value="Queries specifying the contents of this Extract."/> <min value="0"/> <max value="*"/> <base> <path value="EXTRACT_SPEC.criteria"/> <min value="0"/> <max value="*"/> </base> <type> <code value="http://openehr.org/fhir/StructureDefinition/DV-PARSABLE"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.other-details"> <path value="EXTRACT_SPEC.other_details"/> <short value="Other specification items."/> <definition value="Other specification items. Archetypable."/> <min value="0"/> <max value="1"/> <base> <path value="EXTRACT_SPEC.other_details"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"/> </type> <isModifier value="false"/> </element> </snapshot> <differential> <element id="EXTRACT_SPEC"> <path value="EXTRACT_SPEC"/> <short value="Specification of an Extract's contents."/> <definition value="Specification of an Extract's contents. Subtypes can be used to add details specific to the type of Extract. The specification consists of attributes specifying the directory, and two further groups of attributes in their own classes, namely a version specfication (which versions of information items are to be included) and a manifest (which entities are to be included in the extract). Use: Used in a request to specify an Extract, as well as to describe what is contained in an Extract."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.version-spec"> <path value="EXTRACT_SPEC.version_spec"/> <short value="Specification of which versions of information items to include in the Extract."/> <definition value="Specification of which versions of information items to include in the Extract. If Void, the default is latest versions only (which is reasonable for non-versioning systems as well)."/> <min value="0"/> <max value="1"/> <type> <code value="http://openehr.org/fhir/StructureDefinition/EXTRACT-VERSION-SPEC"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.manifest"> <path value="EXTRACT_SPEC.manifest"/> <short value="Specification of entities (e."/> <definition value="Specification of entities (e.g. records) to include in the Extract."/> <min value="1"/> <max value="1"/> <type> <code value="http://openehr.org/fhir/StructureDefinition/EXTRACT-MANIFEST"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.extract-type"> <path value="EXTRACT_SPEC.extract_type"/> <short value="Coded term indicating the type of content required, e."/> <definition value="Coded term indicating the type of content required, e.g. * `|openehr-ehr|` * `|openehr-demographic|` * `|generic-emr|` * `|other|` Coded by openEHR Terminology group `'extract content type'`."/> <min value="1"/> <max value="1"/> <type> <code value="http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.include-multimedia"> <path value="EXTRACT_SPEC.include_multimedia"/> <short value="Indicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not."/> <definition value="Indicates whether in-line instances of `DV_MULTIMEDIA` in the source data are included or not."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.priority"> <path value="EXTRACT_SPEC.priority"/> <short value="Requested priority of this request to be handled by server."/> <definition value="Requested priority of this request to be handled by server. Priority schemes are likely to be local, and use values agreed by both ends. TBD: alternative is standard coded terms"/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.link-depth"> <path value="EXTRACT_SPEC.link_depth"/> <short value="Degree of links to follow emanating from content items specified for inclusion."/> <definition value="Degree of links to follow emanating from content items specified for inclusion. The kind of links to follow is dependent on the type of Extract. All items at the target end of followed links at the given depth are also included in the extract; `EXTRACT_CONTENT_ITEM._is_primary_` is used to differentiate. * 0 = don't follow; * 1 = follow first degree links; * 2 = follow 2nd degree links; * .... * n = follow nth degree links "/> <min value="1"/> <max value="1"/> <type> <code value="integer"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.criteria"> <path value="EXTRACT_SPEC.criteria"/> <short value="Queries specifying the contents of this Extract."/> <definition value="Queries specifying the contents of this Extract."/> <min value="0"/> <max value="*"/> <type> <code value="http://openehr.org/fhir/StructureDefinition/DV-PARSABLE"/> </type> <isModifier value="false"/> </element> <element id="EXTRACT_SPEC.other-details"> <path value="EXTRACT_SPEC.other_details"/> <short value="Other specification items."/> <definition value="Other specification items. Archetypable."/> <min value="0"/> <max value="1"/> <type> <code value="http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"/> </type> <isModifier value="false"/> </element> </differential> </StructureDefinition>