Conformance-uslaborder-orderer.xml

USLabOrder Orderer (id = "uslaborder-orderer")

Raw XML

<Conformance xmlns="http://hl7.org/fhir">
  <id value="uslaborder-orderer"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text><!--    EH:   this is the SDC  template for conformance examples which I will run to try to
   generate the text   -->
  <name value="USLabOrder Orderer"/>
  <publisher value="Published by: HL7 Orders and Observation Workgroup. Primary Author: Eric Haas  Health
   eData Inc"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/"/>
    </telecom>
  </contact>
  <description value="This profile defines the expected capabilities of the USLabOrder Orderer actor when conforming
   to the [[uslaborder.html|The US Laboratory Order Implementation (USLabOrder)]].  This
   actor is the originator of a laboratory test order request to the laboratory (order filler)
   and declares conformance to RESTful FHIR and FHIR profiles defined in this guide.  The
   order reference one or more FHIR resources conforming to profiles outlined in the USLabOrder
   guide."/>
  <status value="draft"/>
  <date value="2014-12-02"/>
  <fhirVersion value="0.8"/>
  <acceptUnknown value="false"/>
  <format value="xml"/>
  <format value="json"/><!--    EH:  need to distinguish when orderer in server mode  = Pull: The source is a server,
   and the destination is a client. When the client wants to use the data, it uses a combination
   of search and read so the users can find the data they need
Push/Pull: The source is a server, and the destination is a client. On a regular basis,
   the destination queries the server for it's history, and replicates the changes in its
   own copy of the database
...
or when orderer in client  mode  =Push: The source is a client, and when new data is available,
   it uses create, update, and transaction to push data to the destination, which is a server
      -->
  <rest>
    <mode value="server"/>
    <documentation value="This conformance resource assumes the USLabOrder Orderer is the server, in other words,
     operating in 'Pull'  or 'Push/Pull' RESTful interface.  The USLabOrder Orderer MUST support
     querying one or more resources outlined by the [[uslaborder|USLabOrder Guide]]. The USLabOrder
     Orderer MUST use all the vocabularies and value set constraints defined by the individual
     resource profiles used by USLabOrder. The USLabOrder Orderer MUST implement REST behavior
     according to the [[http|FHIR specification]] and MUST be able to handle errors gracefully
     from Query Responders who may not support the submitted query."/>
    <security>
      <description value="Implementations must meet the security requirements documented in the [[uslaborder|USLabOrder
       Guide assumptions]]."/>
    </security>
    <resource>
      <type value="DiagnosticOrder"/>
      <profile>
        <reference value="do-uslab"/>
      </profile>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="search-type"/>
        <documentation value="Allows a user to search for existing DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="read"/>
        <documentation value="Allows retrieval of a specific known DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="vread"/>
        <documentation value="Allows retrieval of a specific version of a DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="history-instance"/>
        <documentation value="Allows review of changes to a DiagnosticOrder over time"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="create"/>
        <documentation value="Allows defining a new DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="update"/>
        <documentation value="Allows editing of an existing DiagnosticOrder.  Servers may choose to prohibit certain
         types of edits, instead requiring the creation of a new DiagnosticOrder (and potentially
         the retiring of the existing DiagnosticOrder).  Servers may also limit who can change
         particular DiagnosticOrder."/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHOULD&quot;/&gt;
        &lt;/extension   -->
        <code value="validate"/>
        <documentation value="Allows a client to verify whether a particular new DiagnosticOrder or revision of an existing
         DiagnosticOrder would be accepted based on validation and other business rules.  Useful
         for some workflows"/>
      </interaction><!--    interaction&gt;
        EH: comment out for now since deleting is probably not allowed  &lt;extension
       url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation&quot;&gt;
          &lt;valueCode value=&quot;MAY&quot;/&gt;
        &lt;/extension&gt;
        &lt;code value=&quot;delete&quot;/&gt;
        &lt;documentation value=&quot;Allows removal of an existing DiagnosticOrder. 
       Servers may choose to not support deletions or may limit deletions to DiagnosticOrder
       meeting certain requirements.  E.g. only elements with a status of draft or only elements
       that have been retired for at least two years, etc.&quot;/&gt;
      &lt;/interaction    --><!--    EH  flags for support for versioning, read history, update create
    &lt;versioning value=&quot;versioned|no-version&quot;   -->
      <searchInclude value="DiagnosticOrder.subject, DiagnosticOrder.orderer, DiagnosticOrder.supportingInformation,
       DiagnosticOrder.specimen, DiagnosticOrder.uslabcc"/>
    </resource>
  </rest><!--    EH: comment out for now
    &lt;searchParam   --><!--    EH: comment out for now extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-c
  ommon-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   --><!--   name value=&quot;category&quot;/&gt;
        &lt;definition value=&quot;http://hl7.org/fhir/Profile/dataelement#category&quot;/&gt;
        &lt;type value=&quot;token&quot;/&gt;
      &lt;/searchParam&gt;
      &lt;searchParam   --><!--    interaction. operation   -->
  <rest>
    <mode value="client"/>
    <documentation value="The following conformance rules assumes the USLabOrder Orderer is the client, in other
     words, operating in 'Push'  RESTful interface.  The USLabOrder Orderer MUST support querying
     one or more resources outlined by the [[uslaborder|USLabOrder Guide]]. The USLabOrder
     Orderer MUST use all the vocabularies and value set constraints defined by the individual
     resource profiles used by USLabOrder. The USLabOrder Orderer MUST implement REST behavior
     according to the [[http|FHIR specification]] and MUST be able to handle errors gracefully
     from Query Responders who may not support the submitted query."/>
    <security>
      <description value="Implementations must meet the security requirements documented in the [[uslaborder|USLabOrder
       Guide assumptions]]."/>
    </security>
    <resource>
      <type value="DiagnosticOrder"/>
      <profile>
        <reference value="do-uslab"/>
      </profile>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="search-type"/>
        <documentation value="Allows a user to search for existing DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="read"/>
        <documentation value="Allows retrieval of a specific known DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="vread"/>
        <documentation value="Allows retrieval of a specific version of a DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="history-instance"/>
        <documentation value="Allows review of changes to a DiagnosticOrder over time"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="create"/>
        <documentation value="Allows defining a new DiagnosticOrder"/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHALL&quot;/&gt;
        &lt;/extension   -->
        <code value="update"/>
        <documentation value="Allows editing of an existing DiagnosticOrder.  Servers may choose to prohibit certain
         types of edits, instead requiring the creation of a new DiagnosticOrder (and potentially
         the retiring of the existing DiagnosticOrder).  Servers may also limit who can change
         particular DiagnosticOrder."/>
      </interaction>
      <interaction><!--    EH: comment out for now  extension url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-
        common-expectation&quot;&gt;
          &lt;valueCode value=&quot;SHOULD&quot;/&gt;
        &lt;/extension   -->
        <code value="validate"/>
        <documentation value="Allows a client to verify whether a particular new DiagnosticOrder or revision of an existing
         DiagnosticOrder would be accepted based on validation and other business rules.  Useful
         for some workflows"/>
      </interaction><!--    interaction&gt;
        EH: comment out for now since deleting is probably not allowed  &lt;extension
       url=&quot;http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation&quot;&gt;
          &lt;valueCode value=&quot;MAY&quot;/&gt;
        &lt;/extension&gt;
        &lt;code value=&quot;delete&quot;/&gt;
        &lt;documentation value=&quot;Allows removal of an existing DiagnosticOrder. 
       Servers may choose to not support deletions or may limit deletions to DiagnosticOrder
       meeting certain requirements.  E.g. only elements with a status of draft or only elements
       that have been retired for at least two years, etc.&quot;/&gt;
      &lt;/interaction    --><!--    EH  flags for support for versioning, read history, update create
    &lt;versioning value=&quot;versioned|no-version&quot;   -->
      <searchInclude value="DiagnosticOrder.subject, DiagnosticOrder.orderer, DiagnosticOrder.supportingInformation,
       DiagnosticOrder.specimen, DiagnosticOrder.uslabcc"/>
    </resource>
  </rest>
</Conformance>