StructureDefinition: GAO Procedure Request - XML

GAO Procedure Request

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="gao-procedurerequest"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">

      <h2>GAO Procedure Request</h2>

      <p>Profiles the procedure request to ensure that the services ordered can be identified and
         evaluated for appropraiteness</p>

      <h3>Requirements</h3>

      <p>The procedure request resource is required to identify the procedures that were ordered,
         and to provide additional details that may be necessary to evaluate the order for appropriateness.</p>

    </div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/gao-procedurerequest"/>
  <name value="GAO Procedure Request"/>
  <status value="draft"/>
  <date value="2015-09-22T20:02:49+10:00"/>
  <description value="Profiles the procedure request to ensure that the services ordered can be identified and
   evaluated for appropraiteness"/>
  <requirements value="The procedure request resource is required to identify the procedures that were ordered,
   and to provide additional details that may be necessary to evaluate the order for appropriateness."/>
  <fhirVersion value="1.4.0"/>
  <kind value="resource"/>
  <abstract value="false"/>
  <baseType value="ProcedureRequest"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ProcedureRequest"/>
  <derivation value="constraint"/>
  <snapshot>
    <element>
      <path value="ProcedureRequest"/>
      <short value="A request for a procedure to be performed"/>
      <definition value="A request for a procedure to be performed. May be a proposal or an order."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ProcedureRequest"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="ProcedureRequest"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="w5"/>
        <map value="clinical.general"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.id"/>
      <short value="Logical id of this artifact"/>
      <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.id"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="id"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="ProcedureRequest.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.
       Changes to the content may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.meta"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Meta"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="ProcedureRequest.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="Asserting this rule set restricts the content to be only understood by a limited set of
       trading partners. This inherently limits the usefulness of the data in the long term.
       However, the existing health eco-system is highly fractured, and not yet ready to define,
       collect, and exchange data in a generally computable sense. Wherever possible, implementers
       and/or specification writers should avoid using this element as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.implicitRules"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="ProcedureRequest.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="Language is provided to support indexing and accessibility (typically, services such as
       text to speech use the language tag). The html language tag in the narrative applies 
       to the narrative. The language tag on the resource may be used to specify the language
       of other presentations generated from the data in the resource  Not all the content has
       to be in the base language. The Resource.language should not be assumed to apply to the
       narrative automatically. If a language is specified, it should it also be specified on
       the div element in the html (see rules in HTML5 for information about the relationship
       between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="Resource.language"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <description value="A human language."/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="ProcedureRequest.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition value="A human-readable narrative that contains a summary of the resource, and may be used to
       represent the content of the resource to a human. The narrative need not encode all the
       structured data, but is required to contain sufficient detail to make it &quot;clinically
       safe&quot; for a human to just read the narrative. Resource definitions may define what
       content should be represented in the narrative to ensure clinical safety."/>
      <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DomainResource.text"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.contained"/>
      <short value="Contained, inline Resources"/>
      <definition value="These resources do not have an independent existence apart from the resource that contains
       them - they cannot be identified independently, and nor can they have their own independent
       transaction scope."/>
      <comments value="This should never be done when the content can be identified properly, as once identification
       is lost, it is extremely difficult (and context dependent) to restore it again."/>
      <alias value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DomainResource.contained"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.extension"/>
      <short value="Additional Content defined by implementations"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the resource. In order to make the use of extensions safe and manageable, there is
       a strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DomainResource.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the resource, and that modifies the understanding of the element that contains it.
       Usually modifier elements provide negation or qualification. In order to make the use
       of extensions safe and manageable, there is a strict set of governance applied to the
       definition and use of extensions. Though any implementer is allowed to define an extension,
       there is a set of requirements that SHALL be met as part of the definition of the extension.
       Applications processing a resource are required to check for modifier extensions."/>
      <comments value="There can be no stigma associated with the use of extensions by any application, project,
       or standard - regardless of the institution or jurisdiction that uses or defines the extensions.
        The use of extensions is what allows the FHIR specification to retain a core level of
       simplicity for everyone."/>
      <alias value="extensions"/>
      <alias value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DomainResource.modifierExtension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.identifier"/>
      <short value="Unique identifier for the request"/>
      <definition value="Identifiers assigned to this order by the order or by the receiver."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ProcedureRequest.identifier"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Identifier"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="quick"/>
        <map value="ClinicalStatement.identifier"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="id"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.subject"/>
      <short value="Who the procedure should be done to"/>
      <definition value="The person, animal or group that should receive the procedure."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.subject"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Group"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="quick"/>
        <map value="ClinicalStatement.subject"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.focus"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.code"/>
      <short value="What procedure to perform"/>
      <definition value="The specific procedure that is ordered. Use text if the exact nature of the procedure
       cannot be coded."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.code"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="A code to identify a specific procedure ."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/procedure-code"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="quick"/>
        <map value="Procedure.procedureCode"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="class"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.bodySite"/>
      <short value="What part of body to perform on"/>
      <definition value="Indicates the sites on the subject's body where the procedure should be performed (I.e.
       the target sites)."/>
      <comments value="Only used if not implicit in the code found in ProcedureRequest.type."/>
      <requirements value="Knowing where the procedure is made is important for tracking if multiple sites are possible."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ProcedureRequest.bodySite"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="A code that identifies the anatomical location."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/body-site"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="quick"/>
        <map value="Procedure.targetBodySite"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="targetSiteCode"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.reason[x]"/>
      <short value="Why procedure should occur"/>
      <definition value="The reason why the procedure is being proposed or ordered. This procedure request may
       be motivated by a Condition for instance."/>
      <requirements value="The indication for the procedure SHALL be provided."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.reason[x]"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Condition"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="A code that explains the reason why a procedure is  required."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/procedure-reason"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="quick"/>
        <map value="Action.indication.reason"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.scheduled[x]"/>
      <short value="When procedure should occur"/>
      <definition value="The timing schedule for the proposed or ordered procedure. The Schedule data type allows
       many different expressions.  E.g. &quot;Every 8 hours&quot;; &quot;Three times a day&quot;;
       &quot;1/2 an hour before breakfast for 10 days from 23-Dec 2011:&quot;; &quot;15 Oct 2013,
       17 Oct 2013 and 1 Nov 2013&quot;."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.scheduled[x]"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="dateTime"/>
      </type>
      <type>
        <code value="Period"/>
      </type>
      <type>
        <code value="Timing"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="quick"/>
        <map value="Procedure.procedureSchedule"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="when.planned"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.encounter"/>
      <short value="Encounter request created during"/>
      <definition value="The encounter within which the procedure proposal or request was created."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.encounter"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Encounter"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="quick"/>
        <map value="ClinicalStatement.encounter"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="context"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.performer"/>
      <short value="Who should perform the procedure"/>
      <definition value="For example, the surgeon, anaethetist, endoscopist, etc."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.performer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="w5"/>
        <map value="who.actor"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.status"/>
      <short value="proposed | draft | requested | received | accepted | in-progress | completed | suspended
       | rejected | aborted"/>
      <definition value="The status of the order."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.status"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <description value="The status of the request."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/procedure-request-status"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="quick"/>
        <map value="Action.currentStatus"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="status"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.notes"/>
      <short value="Additional information about desired procedure"/>
      <definition value="Any other notes associated with this proposal or order - e.g. provider instructions."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ProcedureRequest.notes"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Annotation"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="quick"/>
        <map value="ClinicalStatement.additionalText"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.asNeeded[x]"/>
      <short value="Preconditions for procedure"/>
      <definition value="If a CodeableConcept is present, it indicates the pre-condition for performing the procedure."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.asNeeded[x]"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="boolean"/>
      </type>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="A coded concept identifying the pre-condition that should hold prior to performing a procedure.
          For example &quot;pain&quot;, &quot;on flare-up&quot;, etc."/>
      </binding>
      <mapping>
        <identity value="quick"/>
        <map value="Proposal.prnReason.reason"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.orderedOn"/>
      <short value="When request was created"/>
      <definition value="The time when the request was made."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.orderedOn"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="dateTime"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="quick"/>
        <map value="Proposal.proposedAtTime"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="when.recorded"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.orderer"/>
      <short value="Who made request"/>
      <definition value="The healthcare professional responsible for proposing or ordering the procedure."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.orderer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="quick"/>
        <map value="ClinicalStatement.statementAuthor"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="who.author"/>
      </mapping>
    </element>
    <element>
      <path value="ProcedureRequest.priority"/>
      <short value="routine | urgent | stat | asap"/>
      <definition value="The clinical priority associated with this order."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ProcedureRequest.priority"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="required"/>
        <description value="The priority of the request."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/procedure-request-priority"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="quick"/>
        <map value="Proposal.urgency"/>
      </mapping>
      <mapping>
        <identity value="w5"/>
        <map value="grade"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="ProcedureRequest"/>
      <short value="A request for a procedure to be performed"/>
      <definition value="A request for a procedure to be performed. May be a proposal or an order."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ProcedureRequest"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="ProcedureRequest.code.coding"/>
      <short value="Code defined by a terminology system"/>
      <definition value="A reference to a code defined by a terminology system."/>
      <comments value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions
       such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of
       codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one
       of the coding values will be labelled as UserSelected = true."/>
      <requirements value="Allows for translations and alternate encodings within a code system.  Also supports communication
       of the same instance to systems requiring different encodings.  The type of procedure
       to be performed SHALL be provided so that it can be evaluated for appropriateness."/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Coding"/>
      </type>
      <isSummary value="true"/>
    </element>
    <element>
      <path value="ProcedureRequest.reason[x]"/>
      <short value="Why procedure should occur"/>
      <definition value="The reason why the procedure is being proposed or ordered. This procedure request may
       be motivated by a Condition for instance."/>
      <requirements value="The indication for the procedure SHALL be provided."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Condition"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <strength value="example"/>
        <description value="A code that explains the reason why a procedure is  required."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/procedure-reason"/>
        </valueSetReference>
      </binding>
    </element>
  </differential>
</StructureDefinition>