Clinical Practice Guidelines
2.0.0 - STU2 International flag

This page is part of the Clinical Guidelines (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: PlanDefinition - CPG Common Registration - XML Representation

Active as of 2024-11-26

Raw xml | Download


<PlanDefinition xmlns="http://hl7.org/fhir">
  <id value="cpg-common-registration"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-workflowdefinition"/>
    <profile
             value="http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-computableplandefinition"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: PlanDefinition cpg-common-registration</b></p><a name="cpg-common-registration"> </a><a name="hccpg-common-registration"> </a><a name="cpg-common-registration-en-US"> </a><p><b>CQF Knowledge capability</b>: shareable</p><p><b>CQF Knowledge capability</b>: computable</p><p><b>CQF Knowledge capability</b>: publishable</p><p><b>url</b>: <a href="PlanDefinition-cpg-common-registration.html">PlanDefinition PlanDefinition - CPG Common Registration</a></p><p><b>identifier</b>: <a href="http://terminology.hl7.org/6.1.0/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt 

This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid: 

Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.

This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:oid:2.16.840.1.113883.4.642.40.48.34.37</p><p><b>version</b>: 2.0.0</p><p><b>name</b>: PlanDefinition_CPG_Common_Registration</p><p><b>title</b>: PlanDefinition - CPG Common Registration</p><p><b>type</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/plan-definition-type workflow-definition}">Workflow Definition</span></p><p><b>status</b>: Active</p><p><b>experimental</b>: true</p><p><b>date</b>: 2024-11-26 17:38:52+0000</p><p><b>publisher</b>: HL7 International / Clinical Decision Support</p><p><b>contact</b>: HL7 International / Clinical Decision Support: <a href="http://www.hl7.org/Special/committees/dss">http://www.hl7.org/Special/committees/dss</a></p><p><b>description</b>: </p><div><p>Plan for registering patient</p>
</div><p><b>jurisdiction</b>: <span title="Codes:{http://unstats.un.org/unsd/methods/m49/m49.htm 001}">World</span></p><p><b>copyright</b>: </p><div><p>© WHO 2019+.</p>
</div><blockquote><p><b>action</b></p><p><b>title</b>: Registration</p><p><b>description</b>: Registration</p><p><b>code</b>: <span title="Codes:{http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-process-cs registration}">Registration</span></p><blockquote><p><b>participant</b></p><p><b>type</b>: Patient</p><p><b>role</b>: <span title="Codes:{http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs C000}">Patient</span></p></blockquote><blockquote><p><b>participant</b></p><p><b>type</b>: Practitioner</p><p><b>role</b>: <span title="Codes:{http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs W000}">Clerical support worker</span></p></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Gather identifying information</p><p><b>description</b>: Gather identifying information</p><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>QuestionnaireResponse</td></tr></table><h3>Participants</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Role</b></td></tr><tr><td style="display: none">*</td><td>Patient</td><td><span title="Codes:{http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs C000}">Patient</span></td></tr></table><p><b>definition</b>: <a href="Questionnaire-cpg-common-identity.html">CPG Common Questionnaire - Identifying information</a></p></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Patient match</p><p><b>description</b>: Patient match</p><blockquote><p><b>input</b></p><p><b>type</b>: QuestionnaireResponse</p><h3>CodeFilters</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Path</b></td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>questionnaire</td><td>unknown http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity: http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity</td></tr></table></blockquote><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Bundle</td></tr></table><h3>Participants</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Extension</b></td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td/><td>Device</td></tr></table><p><b>definition</b>: <a href="http://hl7.org/fhir/OperationDefinition/Patient-match">Find patient matches using MPI based logic</a></p></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Resolve patient match results</p><p><b>description</b>: Resolve patient match results</p><h3>Inputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Bundle</td></tr></table><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Patient</td></tr></table><h3>Participants</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td><td><b>Role</b></td></tr><tr><td style="display: none">*</td><td>Practitioner</td><td><span title="Codes:{http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs W000}">Clerical support worker</span></td></tr></table><p><b>definition</b>: <a href="Questionnaire-cpg-common-resolve-patient-match.html">CPG Common Questionnaire - Resolve Patient Match</a></p></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: New patient</p><p><b>description</b>: New patient</p><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style="display: none">*</td><td>CQL</td><td>not exists %input i where i is Patient</td></tr></table></blockquote><h3>Inputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Patient</td></tr></table><blockquote><p><b>action</b></p><p><b>title</b>: Gather patient information</p><p><b>description</b>: Gather patient information</p><blockquote><p><b>input</b></p><p><b>type</b>: QuestionnaireResponse</p><h3>CodeFilters</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Path</b></td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>questionnaire</td><td>unknown http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity: http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity</td></tr></table></blockquote><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>QuestionnaireResponse</td></tr></table><p><b>definition</b>: <a href="Questionnaire-cpg-common-patient-profile.html">CPG Common Questionnaire - Patient information</a></p></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Record patient data</p><p><b>description</b>: Record patient data</p><blockquote><p><b>input</b></p><p><b>type</b>: QuestionnaireResponse</p><h3>CodeFilters</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Path</b></td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>questionnaire</td><td>unknown http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile: http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile</td></tr></table></blockquote><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Patient</td></tr></table><h3>Participants</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Extension</b></td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td/><td>Device</td></tr></table><p><b>definition</b>: <a href="http://hl7.org/fhir/R4/codesystem-restful-interaction.html">FHIR Restful Interactions</a></p></blockquote></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Existing patient</p><p><b>description</b>: Existing patient</p><blockquote><p><b>condition</b></p><p><b>kind</b>: Applicability</p><h3>Expressions</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style="display: none">*</td><td>CQL</td><td>exists %input i where i is Patient</td></tr></table></blockquote><h3>Inputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Patient</td></tr></table><blockquote><p><b>action</b></p><p><b>title</b>: Ensure patient information is up to date</p><p><b>description</b>: Ensure patient information is up to date</p><blockquote><p><b>input</b></p><p><b>type</b>: QuestionnaireResponse</p><h3>CodeFilters</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Path</b></td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>questionnaire</td><td>unknown http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity: http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity</td></tr></table></blockquote><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>QuestionnaireResponse</td></tr></table><p><b>definition</b>: <a href="Questionnaire-cpg-common-patient-profile.html">CPG Common Questionnaire - Patient information</a></p></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Record patient data</p><p><b>description</b>: Record patient data</p><blockquote><p><b>input</b></p><p><b>type</b>: QuestionnaireResponse</p><h3>CodeFilters</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Path</b></td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td>questionnaire</td><td>unknown http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile: http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile</td></tr></table></blockquote><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Patient</td></tr></table><h3>Participants</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Extension</b></td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td/><td>Device</td></tr></table><p><b>definition</b>: <a href="http://hl7.org/fhir/R4/codesystem-restful-interaction.html">FHIR Restful Interactions</a></p></blockquote></blockquote><blockquote><p><b>action</b></p><p><b>title</b>: Patient summary lookup</p><p><b>description</b>: Patient summary lookup</p><h3>Inputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Patient</td></tr></table><h3>Outputs</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td>Bundle</td></tr></table><h3>Participants</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Extension</b></td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td/><td>Device</td></tr></table><p><b>definition</b>: <a href="OperationDefinition-cpg-common-patient-summary.html">CPG Common Patient Summary</a></p></blockquote></blockquote></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability">
    <valueCode value="shareable"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability">
    <valueCode value="computable"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability">
    <valueCode value="publishable"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/cpg/PlanDefinition/cpg-common-registration"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.40.48.34.37"/>
  </identifier>
  <version value="2.0.0"/>
  <name value="PlanDefinition_CPG_Common_Registration"/>
  <title value="PlanDefinition - CPG Common Registration"/>
  <type>
    <coding>
      <system
              value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
      <code value="workflow-definition"/>
      <display value="Workflow Definition"/>
    </coding>
  </type>
  <status value="active"/>
  <experimental value="true"/>
  <date value="2024-11-26T17:38:52+00:00"/>
  <publisher value="HL7 International / Clinical Decision Support"/>
  <contact>
    <name value="HL7 International / Clinical Decision Support"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss"/>
    </telecom>
  </contact>
  <description value="Plan for registering patient"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <copyright value="© WHO 2019+."/>
  <action>
    <title value="Registration"/>
    <description value="Registration"/>
    <code>
      <coding>
        <system
                value="http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-process-cs"/>
        <code value="registration"/>
      </coding>
    </code>
    <participant>
      <type value="patient"/>
      <role>
        <coding>
          <system
                  value="http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs"/>
          <code value="C000"/>
        </coding>
      </role>
    </participant>
    <participant>
      <type value="practitioner"/>
      <role>
        <coding>
          <system
                  value="http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs"/>
          <code value="W000"/>
          <display value="Clerical support worker"/>
        </coding>
      </role>
    </participant>
    <action>
      <title value="Gather identifying information"/>
      <description value="Gather identifying information"/>
      <output>
        <type value="QuestionnaireResponse"/>
      </output>
      <participant>
        <type value="patient"/>
        <role>
          <coding>
            <system
                    value="http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs"/>
            <code value="C000"/>
          </coding>
        </role>
      </participant>
      <definitionCanonical
                           value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity"/>
    </action>
    <action>
      <title value="Patient match"/>
      <description value="Patient match"/>
      <input>
        <type value="QuestionnaireResponse"/>
        <codeFilter>
          <path value="questionnaire"/>
          <code>
            <system value="urn:ietf:rfc:3986"/>
            <code
                  value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity"/>
          </code>
        </codeFilter>
      </input>
      <output>
        <type value="Bundle"/>
      </output>
      <participant>
        <extension
                   url="http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement">
          <valueCanonical
                          value="http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry"/>
        </extension>
        <type value="device"/>
      </participant>
      <definitionUri
                     value="http://hl7.org/fhir/OperationDefinition/Patient-match"/>
    </action>
    <action>
      <title value="Resolve patient match results"/>
      <description value="Resolve patient match results"/>
      <input>
        <type value="Bundle"/>
      </input>
      <output>
        <type value="Patient"/>
      </output>
      <participant>
        <type value="practitioner"/>
        <role>
          <coding>
            <system
                    value="http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-common-persona-cs"/>
            <code value="W000"/>
            <display value="Clerical support worker"/>
          </coding>
        </role>
      </participant>
      <definitionCanonical
                           value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-resolve-patient-match"/>
    </action>
    <action>
      <title value="New patient"/>
      <description value="New patient"/>
      <condition>
        <kind value="applicability"/>
        <expression>
          <language value="text/cql"/>
          <expression value="not exists %input i where i is Patient"/>
        </expression>
      </condition>
      <input>
        <type value="Patient"/>
      </input>
      <action>
        <title value="Gather patient information"/>
        <description value="Gather patient information"/>
        <input>
          <type value="QuestionnaireResponse"/>
          <codeFilter>
            <path value="questionnaire"/>
            <code>
              <system value="urn:ietf:rfc:3986"/>
              <code
                    value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity"/>
            </code>
          </codeFilter>
        </input>
        <output>
          <type value="QuestionnaireResponse"/>
        </output>
        <definitionCanonical
                             value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile"/>
      </action>
      <action>
        <title value="Record patient data"/>
        <description value="Record patient data"/>
        <input>
          <type value="QuestionnaireResponse"/>
          <codeFilter>
            <path value="questionnaire"/>
            <code>
              <system value="urn:ietf:rfc:3986"/>
              <code
                    value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile"/>
            </code>
          </codeFilter>
        </input>
        <output>
          <type value="Patient"/>
        </output>
        <participant>
          <extension
                     url="http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement">
            <valueCanonical
                            value="http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry"/>
          </extension>
          <type value="device"/>
        </participant>
        <definitionUri
                       value="http://hl7.org/fhir/restful-interaction#create"/>
      </action>
    </action>
    <action>
      <title value="Existing patient"/>
      <description value="Existing patient"/>
      <condition>
        <kind value="applicability"/>
        <expression>
          <language value="text/cql"/>
          <expression value="exists %input i where i is Patient"/>
        </expression>
      </condition>
      <input>
        <type value="Patient"/>
      </input>
      <action>
        <title value="Ensure patient information is up to date"/>
        <description value="Ensure patient information is up to date"/>
        <input>
          <type value="QuestionnaireResponse"/>
          <codeFilter>
            <path value="questionnaire"/>
            <code>
              <system value="urn:ietf:rfc:3986"/>
              <code
                    value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity"/>
            </code>
          </codeFilter>
        </input>
        <output>
          <type value="QuestionnaireResponse"/>
        </output>
        <definitionCanonical
                             value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile"/>
      </action>
      <action>
        <title value="Record patient data"/>
        <description value="Record patient data"/>
        <input>
          <type value="QuestionnaireResponse"/>
          <codeFilter>
            <path value="questionnaire"/>
            <code>
              <system value="urn:ietf:rfc:3986"/>
              <code
                    value="http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-patient-profile"/>
            </code>
          </codeFilter>
        </input>
        <output>
          <type value="Patient"/>
        </output>
        <participant>
          <extension
                     url="http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement">
            <valueCanonical
                            value="http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry"/>
          </extension>
          <type value="device"/>
        </participant>
        <definitionUri
                       value="http://hl7.org/fhir/restful-interaction#update"/>
      </action>
    </action>
    <action>
      <title value="Patient summary lookup"/>
      <description value="Patient summary lookup"/>
      <input>
        <type value="Patient"/>
      </input>
      <output>
        <type value="Bundle"/>
      </output>
      <participant>
        <extension
                   url="http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-participantCapabilityStatement">
          <valueCanonical
                          value="http://hl7.org/fhir/uv/cpg/CapabilityStatement/cpg-common-patient-registry"/>
        </extension>
        <type value="device"/>
      </participant>
      <definitionUri
                     value="http://hl7.org/fhir/uv/cpg/OperationDefinition/cpg-common-patient-summary"/>
    </action>
  </action>
</PlanDefinition>