STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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 R3

Codesystem-testscript-operation-codes.xml

Raw XML (canonical form)

Definition for Code System TestScriptOperationCode

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="testscript-operation-codes"/>
  <meta>
    <lastUpdated value="2016-12-06T12:22:34.981+11:00"/>
    <profile value="http://hl7.org/fhir/StructureDefinition/codesystem-shareable-definition"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>TestScriptOperationCode</h2>
      <div>
        <p>This value set defines a set of codes that are used to indicate the supported operations
           of a testing engine or tool.</p>

      </div>
      <p>This code system http://hl7.org/fhir/testscript-operation-codes defines the following
         codes:</p>
      <table class="codes">
        <tr>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
        <tr>
          <td>read
            <a name="testscript-operation-codes-read"> </a>
          </td>
          <td>Read</td>
          <td>Read the current state of the resource.</td>
        </tr>
        <tr>
          <td>vread
            <a name="testscript-operation-codes-vread"> </a>
          </td>
          <td>Version Read</td>
          <td>Read the state of a specific version of the resource.</td>
        </tr>
        <tr>
          <td>update
            <a name="testscript-operation-codes-update"> </a>
          </td>
          <td>Update</td>
          <td>Update an existing resource by its id.</td>
        </tr>
        <tr>
          <td>updateCreate
            <a name="testscript-operation-codes-updateCreate"> </a>
          </td>
          <td>Create using Update</td>
          <td>Update an existing resource by its id (or create it if it is new).</td>
        </tr>
        <tr>
          <td>delete
            <a name="testscript-operation-codes-delete"> </a>
          </td>
          <td>Delete</td>
          <td>Delete a resource.</td>
        </tr>
        <tr>
          <td>deleteCondSingle
            <a name="testscript-operation-codes-deleteCondSingle"> </a>
          </td>
          <td>Conditional Delete Single</td>
          <td>Conditionally delete a single resource based on search parameters.</td>
        </tr>
        <tr>
          <td>deleteCondMultiple
            <a name="testscript-operation-codes-deleteCondMultiple"> </a>
          </td>
          <td>Conditional Delete Multiple</td>
          <td>Conditionally delete one or more resources based on search parameters.</td>
        </tr>
        <tr>
          <td>history
            <a name="testscript-operation-codes-history"> </a>
          </td>
          <td>History</td>
          <td>Retrieve the change history for a particular resource or resource type.</td>
        </tr>
        <tr>
          <td>create
            <a name="testscript-operation-codes-create"> </a>
          </td>
          <td>Create</td>
          <td>Create a new resource with a server assigned id.</td>
        </tr>
        <tr>
          <td>search
            <a name="testscript-operation-codes-search"> </a>
          </td>
          <td>Search</td>
          <td>Search based on some filter criteria.</td>
        </tr>
        <tr>
          <td>batch
            <a name="testscript-operation-codes-batch"> </a>
          </td>
          <td>Batch</td>
          <td>Update, create or delete a set of resources as independent actions.</td>
        </tr>
        <tr>
          <td>transaction
            <a name="testscript-operation-codes-transaction"> </a>
          </td>
          <td>Transaction</td>
          <td>Update, create or delete a set of resources as a single transaction.</td>
        </tr>
        <tr>
          <td>capabilities
            <a name="testscript-operation-codes-capabilities"> </a>
          </td>
          <td>Capabilities</td>
          <td>Get a capability statement for the system.</td>
        </tr>
        <tr>
          <td>apply
            <a name="testscript-operation-codes-apply"> </a>
          </td>
          <td>$apply</td>
          <td>Realize a definition in a specific context</td>
        </tr>
        <tr>
          <td>cancel
            <a name="testscript-operation-codes-cancel"> </a>
          </td>
          <td>$cancel</td>
          <td>Cancel Task</td>
        </tr>
        <tr>
          <td>closure
            <a name="testscript-operation-codes-closure"> </a>
          </td>
          <td>$closure</td>
          <td>Closure Table Maintenance</td>
        </tr>
        <tr>
          <td>compose
            <a name="testscript-operation-codes-compose"> </a>
          </td>
          <td>$compose</td>
          <td>Code Composition based on supplied properties</td>
        </tr>
        <tr>
          <td>conforms
            <a name="testscript-operation-codes-conforms"> </a>
          </td>
          <td>$conforms</td>
          <td>Test if a server implements a client's required operations</td>
        </tr>
        <tr>
          <td>data-requirements
            <a name="testscript-operation-codes-data-requirements"> </a>
          </td>
          <td>$data-requirements</td>
          <td>Aggregates and return the parameters and data requirements as a single module definition
             library</td>
        </tr>
        <tr>
          <td>document
            <a name="testscript-operation-codes-document"> </a>
          </td>
          <td>$document</td>
          <td>Generate a Document</td>
        </tr>
        <tr>
          <td>evaluate
            <a name="testscript-operation-codes-evaluate"> </a>
          </td>
          <td>$evaluate</td>
          <td>Evaluate DecisionSupportRule / DecisionSupportServiceModule</td>
        </tr>
        <tr>
          <td>evaluate-measure
            <a name="testscript-operation-codes-evaluate-measure"> </a>
          </td>
          <td>$evaluate-measure</td>
          <td>Evaluate Measure</td>
        </tr>
        <tr>
          <td>everything
            <a name="testscript-operation-codes-everything"> </a>
          </td>
          <td>$everything</td>
          <td>Fetch Encounter/Patient Record</td>
        </tr>
        <tr>
          <td>expand
            <a name="testscript-operation-codes-expand"> </a>
          </td>
          <td>$expand</td>
          <td>Value Set Expansion</td>
        </tr>
        <tr>
          <td>fail
            <a name="testscript-operation-codes-fail"> </a>
          </td>
          <td>$fail</td>
          <td>Fail Task</td>
        </tr>
        <tr>
          <td>find
            <a name="testscript-operation-codes-find"> </a>
          </td>
          <td>$find</td>
          <td>Find a functional list</td>
        </tr>
        <tr>
          <td>finish
            <a name="testscript-operation-codes-finish"> </a>
          </td>
          <td>$finish</td>
          <td>Finish Task</td>
        </tr>
        <tr>
          <td>implements
            <a name="testscript-operation-codes-implements"> </a>
          </td>
          <td>$implements</td>
          <td>Test if a server implements a client's required operations</td>
        </tr>
        <tr>
          <td>lookup
            <a name="testscript-operation-codes-lookup"> </a>
          </td>
          <td>$lookup</td>
          <td>Concept Look Up</td>
        </tr>
        <tr>
          <td>match
            <a name="testscript-operation-codes-match"> </a>
          </td>
          <td>$match</td>
          <td>Find patient matches using MPI based logic</td>
        </tr>
        <tr>
          <td>meta
            <a name="testscript-operation-codes-meta"> </a>
          </td>
          <td>$meta</td>
          <td>Access a list of profiles, tags, and security labels</td>
        </tr>
        <tr>
          <td>meta-add
            <a name="testscript-operation-codes-meta-add"> </a>
          </td>
          <td>$meta-add</td>
          <td>Add profiles, tags, and security labels to a resource</td>
        </tr>
        <tr>
          <td>meta-delete
            <a name="testscript-operation-codes-meta-delete"> </a>
          </td>
          <td>$meta-delete</td>
          <td>Delete profiles, tags, and security labels for a resource</td>
        </tr>
        <tr>
          <td>populate
            <a name="testscript-operation-codes-populate"> </a>
          </td>
          <td>$populate</td>
          <td>Populate Questionnaire</td>
        </tr>
        <tr>
          <td>populatehtml
            <a name="testscript-operation-codes-populatehtml"> </a>
          </td>
          <td>$populatehtml</td>
          <td>Generate HTML for Questionnaire</td>
        </tr>
        <tr>
          <td>populatelink
            <a name="testscript-operation-codes-populatelink"> </a>
          </td>
          <td>$populatelink</td>
          <td>Generate a link to a Questionnaire completion webpage</td>
        </tr>
        <tr>
          <td>process-message
            <a name="testscript-operation-codes-process-message"> </a>
          </td>
          <td>$process-message</td>
          <td>Process Message</td>
        </tr>
        <tr>
          <td>questionnaire
            <a name="testscript-operation-codes-questionnaire"> </a>
          </td>
          <td>$questionnaire</td>
          <td>Build Questionnaire</td>
        </tr>
        <tr>
          <td>release
            <a name="testscript-operation-codes-release"> </a>
          </td>
          <td>$release</td>
          <td>Release Task</td>
        </tr>
        <tr>
          <td>reserve
            <a name="testscript-operation-codes-reserve"> </a>
          </td>
          <td>$reserve</td>
          <td>Reserve Task</td>
        </tr>
        <tr>
          <td>resume
            <a name="testscript-operation-codes-resume"> </a>
          </td>
          <td>$resume</td>
          <td>Resume Task</td>
        </tr>
        <tr>
          <td>set-input
            <a name="testscript-operation-codes-set-input"> </a>
          </td>
          <td>$set-input</td>
          <td>Set Task Input</td>
        </tr>
        <tr>
          <td>set-output
            <a name="testscript-operation-codes-set-output"> </a>
          </td>
          <td>$set-output</td>
          <td>Set Task Output</td>
        </tr>
        <tr>
          <td>start
            <a name="testscript-operation-codes-start"> </a>
          </td>
          <td>$start</td>
          <td>Start Task</td>
        </tr>
        <tr>
          <td>stats
            <a name="testscript-operation-codes-stats"> </a>
          </td>
          <td>$stats</td>
          <td>Observation Statistics</td>
        </tr>
        <tr>
          <td>stop
            <a name="testscript-operation-codes-stop"> </a>
          </td>
          <td>$stop</td>
          <td>Stop Task</td>
        </tr>
        <tr>
          <td>subset
            <a name="testscript-operation-codes-subset"> </a>
          </td>
          <td>$subset</td>
          <td>Fetch a subset of the CapabilityStatement resource</td>
        </tr>
        <tr>
          <td>subsumes
            <a name="testscript-operation-codes-subsumes"> </a>
          </td>
          <td>$subsumes</td>
          <td>Determine if code A is subsumed by code B</td>
        </tr>
        <tr>
          <td>suspend
            <a name="testscript-operation-codes-suspend"> </a>
          </td>
          <td>$suspend</td>
          <td>Suspend Task</td>
        </tr>
        <tr>
          <td>transform
            <a name="testscript-operation-codes-transform"> </a>
          </td>
          <td>$transform</td>
          <td>Model Instance Transformation</td>
        </tr>
        <tr>
          <td>translate
            <a name="testscript-operation-codes-translate"> </a>
          </td>
          <td>$translate</td>
          <td>Concept Translation</td>
        </tr>
        <tr>
          <td>validate
            <a name="testscript-operation-codes-validate"> </a>
          </td>
          <td>$validate</td>
          <td>Validate a resource</td>
        </tr>
        <tr>
          <td>validate-code
            <a name="testscript-operation-codes-validate-code"> </a>
          </td>
          <td>$validate-code</td>
          <td>Value Set based Validation</td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/testscript-operation-codes"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.1.898"/>
  </identifier>
  <version value="1.8.0"/>
  <name value="TestScriptOperationCode"/>
  <status value="draft"/>
  <experimental value="true"/>
  <publisher value="FHIR Project team"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <description value="This value set defines a set of codes that are used to indicate the supported operations
   of a testing engine or tool."/>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/testscript-operation-codes"/>
  <content value="complete"/>
  <concept>
    <code value="read"/>
    <display value="Read"/>
    <definition value="Read the current state of the resource."/>
  </concept>
  <concept>
    <code value="vread"/>
    <display value="Version Read"/>
    <definition value="Read the state of a specific version of the resource."/>
  </concept>
  <concept>
    <code value="update"/>
    <display value="Update"/>
    <definition value="Update an existing resource by its id."/>
  </concept>
  <concept>
    <code value="updateCreate"/>
    <display value="Create using Update"/>
    <definition value="Update an existing resource by its id (or create it if it is new)."/>
  </concept>
  <concept>
    <code value="delete"/>
    <display value="Delete"/>
    <definition value="Delete a resource."/>
  </concept>
  <concept>
    <code value="deleteCondSingle"/>
    <display value="Conditional Delete Single"/>
    <definition value="Conditionally delete a single resource based on search parameters."/>
  </concept>
  <concept>
    <code value="deleteCondMultiple"/>
    <display value="Conditional Delete Multiple"/>
    <definition value="Conditionally delete one or more resources based on search parameters."/>
  </concept>
  <concept>
    <code value="history"/>
    <display value="History"/>
    <definition value="Retrieve the change history for a particular resource or resource type."/>
  </concept>
  <concept>
    <code value="create"/>
    <display value="Create"/>
    <definition value="Create a new resource with a server assigned id."/>
  </concept>
  <concept>
    <code value="search"/>
    <display value="Search"/>
    <definition value="Search based on some filter criteria."/>
  </concept>
  <concept>
    <code value="batch"/>
    <display value="Batch"/>
    <definition value="Update, create or delete a set of resources as independent actions."/>
  </concept>
  <concept>
    <code value="transaction"/>
    <display value="Transaction"/>
    <definition value="Update, create or delete a set of resources as a single transaction."/>
  </concept>
  <concept>
    <code value="capabilities"/>
    <display value="Capabilities"/>
    <definition value="Get a capability statement for the system."/>
  </concept>
  <concept>
    <code value="apply"/>
    <display value="$apply"/>
    <definition value="Realize a definition in a specific context"/>
  </concept>
  <concept>
    <code value="cancel"/>
    <display value="$cancel"/>
    <definition value="Cancel Task"/>
  </concept>
  <concept>
    <code value="closure"/>
    <display value="$closure"/>
    <definition value="Closure Table Maintenance"/>
  </concept>
  <concept>
    <code value="compose"/>
    <display value="$compose"/>
    <definition value="Code Composition based on supplied properties"/>
  </concept>
  <concept>
    <code value="conforms"/>
    <display value="$conforms"/>
    <definition value="Test if a server implements a client's required operations"/>
  </concept>
  <concept>
    <code value="data-requirements"/>
    <display value="$data-requirements"/>
    <definition value="Aggregates and return the parameters and data requirements as a single module definition
     library"/>
  </concept>
  <concept>
    <code value="document"/>
    <display value="$document"/>
    <definition value="Generate a Document"/>
  </concept>
  <concept>
    <code value="evaluate"/>
    <display value="$evaluate"/>
    <definition value="Evaluate DecisionSupportRule / DecisionSupportServiceModule"/>
  </concept>
  <concept>
    <code value="evaluate-measure"/>
    <display value="$evaluate-measure"/>
    <definition value="Evaluate Measure"/>
  </concept>
  <concept>
    <code value="everything"/>
    <display value="$everything"/>
    <definition value="Fetch Encounter/Patient Record"/>
  </concept>
  <concept>
    <code value="expand"/>
    <display value="$expand"/>
    <definition value="Value Set Expansion"/>
  </concept>
  <concept>
    <code value="fail"/>
    <display value="$fail"/>
    <definition value="Fail Task"/>
  </concept>
  <concept>
    <code value="find"/>
    <display value="$find"/>
    <definition value="Find a functional list"/>
  </concept>
  <concept>
    <code value="finish"/>
    <display value="$finish"/>
    <definition value="Finish Task"/>
  </concept>
  <concept>
    <code value="implements"/>
    <display value="$implements"/>
    <definition value="Test if a server implements a client's required operations"/>
  </concept>
  <concept>
    <code value="lookup"/>
    <display value="$lookup"/>
    <definition value="Concept Look Up"/>
  </concept>
  <concept>
    <code value="match"/>
    <display value="$match"/>
    <definition value="Find patient matches using MPI based logic"/>
  </concept>
  <concept>
    <code value="meta"/>
    <display value="$meta"/>
    <definition value="Access a list of profiles, tags, and security labels"/>
  </concept>
  <concept>
    <code value="meta-add"/>
    <display value="$meta-add"/>
    <definition value="Add profiles, tags, and security labels to a resource"/>
  </concept>
  <concept>
    <code value="meta-delete"/>
    <display value="$meta-delete"/>
    <definition value="Delete profiles, tags, and security labels for a resource"/>
  </concept>
  <concept>
    <code value="populate"/>
    <display value="$populate"/>
    <definition value="Populate Questionnaire"/>
  </concept>
  <concept>
    <code value="populatehtml"/>
    <display value="$populatehtml"/>
    <definition value="Generate HTML for Questionnaire"/>
  </concept>
  <concept>
    <code value="populatelink"/>
    <display value="$populatelink"/>
    <definition value="Generate a link to a Questionnaire completion webpage"/>
  </concept>
  <concept>
    <code value="process-message"/>
    <display value="$process-message"/>
    <definition value="Process Message"/>
  </concept>
  <concept>
    <code value="questionnaire"/>
    <display value="$questionnaire"/>
    <definition value="Build Questionnaire"/>
  </concept>
  <concept>
    <code value="release"/>
    <display value="$release"/>
    <definition value="Release Task"/>
  </concept>
  <concept>
    <code value="reserve"/>
    <display value="$reserve"/>
    <definition value="Reserve Task"/>
  </concept>
  <concept>
    <code value="resume"/>
    <display value="$resume"/>
    <definition value="Resume Task"/>
  </concept>
  <concept>
    <code value="set-input"/>
    <display value="$set-input"/>
    <definition value="Set Task Input"/>
  </concept>
  <concept>
    <code value="set-output"/>
    <display value="$set-output"/>
    <definition value="Set Task Output"/>
  </concept>
  <concept>
    <code value="start"/>
    <display value="$start"/>
    <definition value="Start Task"/>
  </concept>
  <concept>
    <code value="stats"/>
    <display value="$stats"/>
    <definition value="Observation Statistics"/>
  </concept>
  <concept>
    <code value="stop"/>
    <display value="$stop"/>
    <definition value="Stop Task"/>
  </concept>
  <concept>
    <code value="subset"/>
    <display value="$subset"/>
    <definition value="Fetch a subset of the CapabilityStatement resource"/>
  </concept>
  <concept>
    <code value="subsumes"/>
    <display value="$subsumes"/>
    <definition value="Determine if code A is subsumed by code B"/>
  </concept>
  <concept>
    <code value="suspend"/>
    <display value="$suspend"/>
    <definition value="Suspend Task"/>
  </concept>
  <concept>
    <code value="transform"/>
    <display value="$transform"/>
    <definition value="Model Instance Transformation"/>
  </concept>
  <concept>
    <code value="translate"/>
    <display value="$translate"/>
    <definition value="Concept Translation"/>
  </concept>
  <concept>
    <code value="validate"/>
    <display value="$validate"/>
    <definition value="Validate a resource"/>
  </concept>
  <concept>
    <code value="validate-code"/>
    <display value="$validate-code"/>
    <definition value="Value Set based Validation"/>
  </concept>
</CodeSystem>

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.