Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension-workflow-researchstudy.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

researchStudy

<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="workflow-researchStudy"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/workflow-researchStudy"/> 
  <version value="4.4.0"/> 
  <name value="researchStudy"/> 
  <title value="Associated Study"/> 
  <status value="draft"/> 
  <date value="2017-12-06"/> 
  <publisher value="Health Level Seven, Inc. - FHIR WG"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/special/committees/fwg"/> 
    </telecom> 
  </contact> 
  <description value="Indicates that this event is relevant to the specified research study(ies)."/> 
  <fhirVersion value="4.4.0"/> 
  <mapping> 
    <identity value="workflow"/> 
    <uri value="http://hl7.org/fhir/workflow"/> 
    <name value="Workflow Pattern"/> 
  </mapping> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <context> 
    <type value="element"/> 
    <expression value="Composition"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="Consent"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="DeviceUseStatement"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="DiagnosticReport"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="Encounter"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="FamilyMemberHistory"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="Immunization"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="DocumentReference"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="MedicationAdministration"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="MedicationDispense"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="MedicationUsage"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="Observation"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="Procedure"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="QuestionnaireResponse"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="RiskAssessment"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="SupplyDelivery"/> 
  </context> 
  <context> 
    <type value="element"/> 
    <expression value="Task"/> 
  </context> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Associated research study"/> 
      <definition value="Indicates that this event is relevant to the specified research study(ies)."/> 
      <comment value="This relevance might mean that the even occurred as part of the study protocol, but can
       also include events that occurred outside the study but still have relevance (e.g. adverse
       events, co-occurring medications, unexpected Observations, etc.)."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/null"/> 
      </constraint> 
      <isModifier value="false"/> 
      <mapping> 
        <identity value="workflow"/> 
        <map value="Event.researchStudy"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".outboundRelationship[typeCode=PERT].target[classCode=CLNTRL, moodCode=EVN]"/> 
      </mapping> 
    </element> 
    <element id="Extension.id">
      <path value="Extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may be any
       string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUri value="string"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="The definition may point directly to a computable or human-readable definition of the
       extensibility codes, or it may be a logical URI as declared in some other specification.
       The definition SHALL be a URI for the Structure Definition defining the extension."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUri value="uri"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/workflow-researchStudy"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensi
      bility.html) for a list)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/ResearchStudy"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Associated research study"/> 
      <definition value="Indicates that this event is relevant to the specified research study(ies)."/> 
      <comment value="This relevance might mean that the even occurred as part of the study protocol, but can
       also include events that occurred outside the study but still have relevance (e.g. adverse
       events, co-occurring medications, unexpected Observations, etc.)."/> 
      <min value="0"/> 
      <max value="*"/> 
      <mapping> 
        <identity value="workflow"/> 
        <map value="Event.researchStudy"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".outboundRelationship[typeCode=PERT].target[classCode=CLNTRL, moodCode=EVN]"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/workflow-researchStudy"/> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <min value="1"/> 
      <type> 
        <code value="Reference"/> 
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/ResearchStudy"/> 
      </type> 
    </element> 
  </differential> 
</StructureDefinition> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.