Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm
2.0.0 - STU2 United States of America flag

This page is part of the electronic Long-Term Services and Supports Implementation Guide (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

: All Eltss Careplan - XML Representation

Page standards status: Informative

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="all-eltss-careplan"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/CarePlan/[id]/$all-eltss-careplan</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>The Server may wish to enable paging of the output for large bundles.</p>
</div></td></tr></table><div><p>Use example URL: [base]/CarePlan/[id]/$all-eltss-careplan
Resources which should be returned:</p>
<p>CarePlan<br/>
Practitioner<br/>
Observation<br/>
RiskAssessment<br/>
HealthcareService<br/>
Organization<br/>
Coverage<br/>
Claim<br/>
Contract<br/>
Task<br/>
ServiceRequest<br/>
Patient<br/>
Goal<br/>
Condition<br/>
CareTeam<br/>
Encounter<br/>
EpisodeOfCare<br/>
Location<br/>
QuestionnaireResponse<br/>
Questionnaire<br/>
RelatedPerson<br/>
PractitionerRole</p>
<p>Example Request Parameters that this Operation is to perform as one action:</p>
<p>CarePlan?_id=68
&amp;_include=CarePlan%3Aactivity-reference</p>
<p>&amp;_include=CarePlan%3Acare-team</p>
<p>&amp;_include=CarePlan%3Acondition</p>
<p>&amp;_include=CarePlan%3Aencounter</p>
<p>&amp;_include=CarePlan%3Agoal</p>
<p>&amp;_include=CarePlan%3Aperformer</p>
<p>&amp;_include=CarePlan%3Asubject</p>
<p>&amp;_profile=http%3A%2F%2Fhl7.org%2Ffhir%2Fus%2FeLTSS%2FStructureDefinition%2FCarePlan-eltss</p>
<p>Followed by individual requests for:</p>
<p>Practitioner?_id=80827658-9560-4ed5-8ff6-0cc93de6214d<br/>
Observation?_id=28291
Observation?_id=28303
Observation?_id=28304
RiskAssessment?_id=28357<br/>
RiskAssessment?_id=28358<br/>
HealthcareService?_id=28364<br/>
HealthcareService?_id=28289<br/>
HealthcareService?_id=28359<br/>
Organization?_id=28295<br/>
HealthcareService?_id=28414<br/>
Coverage?_id=28366&amp;_include=Coverage%3Apayor<br/>
Coverage?_id=28361&amp;_include=Coverage%3Apayor<br/>
Coverage?_id=28297&amp;_include=Coverage%3Apayor<br/>
Claim?_id=28367              Claim?_id=28362<br/>
Claim?_id=28298<br/>
Patient?_id=CMS2023-patientBSJ1</p>
</div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="hsswg"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="informative">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/eltss/ImplementationGuide/hl7.fhir.us.eltss"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/us/eltss/OperationDefinition/all-eltss-careplan"/>
  <version value="2.0.0"/>
  <name value="AllEltssCareplan"/>
  <title value="All Eltss Careplan"/>
  <status value="draft"/>
  <kind value="operation"/>
  <experimental value="true"/>
  <date value="2024-05-27T02:52:51+00:00"/>
  <publisher value="HL7 International / Human and Social Services"/>
  <contact>
    <name value="HL7 International / Human and Social Services"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/hsswg"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="hhswg@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="Provide all eLTSS data for a given Patient's CarePlan. Given a CarePlan with a specific Patient and ID, this operation will return all the referenced artifacts necessary to satisfy the eLTSS data element set found in the DAM. The Operation reduces the number of queries that a client must make. This operation definition is in draft and should be revised in subsequent versions of this IG. The parameter here is a single output parameter named return. This means that the expectation is that a single Bundle Resource will be returned. The type for the bundle can be collection."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="all-eltss-careplan"/>
  <comment
           value="Use example URL: [base]/CarePlan/[id]/$all-eltss-careplan 
 Resources which should be returned:

CarePlan         
Practitioner         
Observation         
RiskAssessment         
HealthcareService         
Organization         
Coverage         
Claim                 
Contract                
Task         
ServiceRequest         
Patient         
Goal         
Condition         
CareTeam         
Encounter         
EpisodeOfCare         
Location  
QuestionnaireResponse                
Questionnaire                
RelatedPerson         
PractitionerRole                
  
 
Example Request Parameters that this Operation is to perform as one action: 
 
CarePlan?_id=68 
&amp;_include=CarePlan%3Aactivity-reference 
 
&amp;_include=CarePlan%3Acare-team 
 
&amp;_include=CarePlan%3Acondition 
 
&amp;_include=CarePlan%3Aencounter 
 
&amp;_include=CarePlan%3Agoal 
 
&amp;_include=CarePlan%3Aperformer 
 
&amp;_include=CarePlan%3Asubject 
 
&amp;_profile=http%3A%2F%2Fhl7.org%2Ffhir%2Fus%2FeLTSS%2FStructureDefinition%2FCarePlan-eltss 
 
Followed by individual requests for: 
 
Practitioner?_id=80827658-9560-4ed5-8ff6-0cc93de6214d            
Observation?_id=28291 
Observation?_id=28303 
Observation?_id=28304 
RiskAssessment?_id=28357         
RiskAssessment?_id=28358         
HealthcareService?_id=28364    
HealthcareService?_id=28289    
HealthcareService?_id=28359    
Organization?_id=28295               
HealthcareService?_id=28414    
Coverage?_id=28366&amp;_include=Coverage%3Apayor        
Coverage?_id=28361&amp;_include=Coverage%3Apayor        
Coverage?_id=28297&amp;_include=Coverage%3Apayor        
Claim?_id=28367              Claim?_id=28362              
Claim?_id=28298              
Patient?_id=CMS2023-patientBSJ1 
"/>
  <resource value="CarePlan"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The Server may wish to enable paging of the output for large bundles."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>