Clinical Practice Guidelines
2.0.0-ballot - ballot International flag

This page is part of the Clinical Guidelines (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

: PlanDefinition - CPG Common Registration - XML Representation

Active as of 2023-12-19

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><b>Generated Narrative: PlanDefinition</b><a name="cpg-common-registration"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource PlanDefinition &quot;cpg-common-registration&quot; </p><p style="margin-bottom: 0px">Profiles: <a href="StructureDefinition-cpg-workflowdefinition.html">CPG Workflow Definition</a>, <a href="StructureDefinition-cpg-computableplandefinition.html">CPG Computable Plan Definition</a></p></div><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>CQF knowledge representation level</b>: structured</p><p><b>StructureDefinition Work Group</b>: cds</p><p><b>url</b>: <code>http://hl7.org/fhir/uv/cpg/PlanDefinition/cpg-common-registration</code></p><p><b>version</b>: 2.0.0-ballot</p><p><b>name</b>: PlanDefinition_CPG_Common_Registration</p><p><b>title</b>: PlanDefinition - CPG Common Registration</p><p><b>type</b>: Workflow Definition <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.3.0/CodeSystem-plan-definition-type.html">PlanDefinitionType</a>#workflow-definition)</span></p><p><b>status</b>: active</p><p><b>experimental</b>: true</p><p><b>date</b>: 2023-12-19 19:53:17+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>: Plan for registering patient</p><p><b>jurisdiction</b>: World <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (m49.htm#001)</span></p><p><b>copyright</b>: © WHO 2019+.</p><blockquote><p><b>action</b></p><p><b>title</b>: Registration</p><p><b>description</b>: Registration</p><p><b>code</b>: Registration <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-cpg-common-process-cs.html">CPG Common Process Code System</a>#registration)</span></p><blockquote><p><b>participant</b></p><p><b>type</b>: patient</p><p><b>role</b>: Patient <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-cpg-common-persona-cs.html">CPG Common Personas Code System</a>#C000)</span></p></blockquote><blockquote><p><b>participant</b></p><p><b>type</b>: practitioner</p><p><b>role</b>: Clerical support worker <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="CodeSystem-cpg-common-persona-cs.html">CPG Common Personas Code System</a>#W000)</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><blockquote><p><b>output</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a></td></tr></table></blockquote><blockquote><p><b>participant</b></p></blockquote><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><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a></td></tr><tr style="background-color: #efefef"><td>Filter</td><td>Value</td></tr><tr><td>questionnaire</td><td>One of these codes: urn:ietf:rfc:3986 http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity: http://hl7.org/fhir/uv/cpg/Questionnaire/cpg-common-identity</td></tr></table></blockquote><blockquote><p><b>output</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td></tr></table></blockquote><blockquote><p><b>participant</b></p></blockquote><p><b>definition</b>: <a href="http://hl7.org/fhir/OperationDefinition/Patient-match">http://hl7.org/fhir/OperationDefinition/Patient-match</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><blockquote><p><b>input</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td></tr></table></blockquote><blockquote><p><b>output</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td></tr></table></blockquote><blockquote><p><b>participant</b></p></blockquote><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></blockquote><blockquote><p><b>input</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td></tr></table></blockquote><blockquote><p><b>action</b></p></blockquote><blockquote><p><b>action</b></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></blockquote><blockquote><p><b>input</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td></tr></table></blockquote><blockquote><p><b>action</b></p></blockquote><blockquote><p><b>action</b></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><blockquote><p><b>input</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td></tr></table></blockquote><blockquote><p><b>output</b></p><table class="grid"><tr><td colspan="2"><b>Type</b>: <a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td></tr></table></blockquote><blockquote><p><b>participant</b></p></blockquote><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>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel">
    <valueCode value="structured"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cds"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/cpg/PlanDefinition/cpg-common-registration"/>
  <version value="2.0.0-ballot"/>
  <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="2023-12-19T19:53:17+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>