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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: All Eltss Careplan - JSON Representation

Page standards status: Informative

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "all-eltss-careplan",
  "text" : {
    "status" : "extensions",
    "div" : "<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>\n</div></td></tr></table><div><p>Use example URL: [base]/CarePlan/[id]/$all-eltss-careplan\nResources which should be returned:</p>\n<p>CarePlan<br/>\nPractitioner<br/>\nObservation<br/>\nRiskAssessment<br/>\nHealthcareService<br/>\nOrganization<br/>\nCoverage<br/>\nClaim<br/>\nContract<br/>\nTask<br/>\nServiceRequest<br/>\nPatient<br/>\nGoal<br/>\nCondition<br/>\nCareTeam<br/>\nEncounter<br/>\nEpisodeOfCare<br/>\nLocation<br/>\nQuestionnaireResponse<br/>\nQuestionnaire<br/>\nRelatedPerson<br/>\nPractitionerRole</p>\n<p>Example Request Parameters that this Operation is to perform as one action:</p>\n<p>CarePlan?_id=68\n&amp;_include=CarePlan%3Aactivity-reference</p>\n<p>&amp;_include=CarePlan%3Acare-team</p>\n<p>&amp;_include=CarePlan%3Acondition</p>\n<p>&amp;_include=CarePlan%3Aencounter</p>\n<p>&amp;_include=CarePlan%3Agoal</p>\n<p>&amp;_include=CarePlan%3Aperformer</p>\n<p>&amp;_include=CarePlan%3Asubject</p>\n<p>&amp;_profile=http%3A%2F%2Fhl7.org%2Ffhir%2Fus%2FeLTSS%2FStructureDefinition%2FCarePlan-eltss</p>\n<p>Followed by individual requests for:</p>\n<p>Practitioner?_id=80827658-9560-4ed5-8ff6-0cc93de6214d<br/>\nObservation?_id=28291\nObservation?_id=28303\nObservation?_id=28304\nRiskAssessment?_id=28357<br/>\nRiskAssessment?_id=28358<br/>\nHealthcareService?_id=28364<br/>\nHealthcareService?_id=28289<br/>\nHealthcareService?_id=28359<br/>\nOrganization?_id=28295<br/>\nHealthcareService?_id=28414<br/>\nCoverage?_id=28366&amp;_include=Coverage%3Apayor<br/>\nCoverage?_id=28361&amp;_include=Coverage%3Apayor<br/>\nCoverage?_id=28297&amp;_include=Coverage%3Apayor<br/>\nClaim?_id=28367              Claim?_id=28362<br/>\nClaim?_id=28298<br/>\nPatient?_id=CMS2023-patientBSJ1</p>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "hsswg"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "informative",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/eltss/ImplementationGuide/hl7.fhir.us.eltss"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/eltss/OperationDefinition/all-eltss-careplan",
  "version" : "2.0.0",
  "name" : "AllEltssCareplan",
  "title" : "All Eltss Careplan",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : true,
  "date" : "2024-05-27T02:32:48+00:00",
  "publisher" : "HL7 International / Human and Social Services",
  "contact" : [
    {
      "name" : "HL7 International / Human and Social Services",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/hsswg"
        },
        {
          "system" : "email",
          "value" : "hhswg@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "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" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "all-eltss-careplan",
  "comment" : "Use example URL: [base]/CarePlan/[id]/$all-eltss-careplan \n Resources which should be returned:\n\nCarePlan         \nPractitioner         \nObservation         \nRiskAssessment         \nHealthcareService         \nOrganization         \nCoverage         \nClaim                 \nContract                \nTask         \nServiceRequest         \nPatient         \nGoal         \nCondition         \nCareTeam         \nEncounter         \nEpisodeOfCare         \nLocation  \nQuestionnaireResponse                \nQuestionnaire                \nRelatedPerson         \nPractitionerRole                \n  \n \nExample Request Parameters that this Operation is to perform as one action: \n \nCarePlan?_id=68 \n&_include=CarePlan%3Aactivity-reference \n \n&_include=CarePlan%3Acare-team \n \n&_include=CarePlan%3Acondition \n \n&_include=CarePlan%3Aencounter \n \n&_include=CarePlan%3Agoal \n \n&_include=CarePlan%3Aperformer \n \n&_include=CarePlan%3Asubject \n \n&_profile=http%3A%2F%2Fhl7.org%2Ffhir%2Fus%2FeLTSS%2FStructureDefinition%2FCarePlan-eltss \n \nFollowed by individual requests for: \n \nPractitioner?_id=80827658-9560-4ed5-8ff6-0cc93de6214d            \nObservation?_id=28291 \nObservation?_id=28303 \nObservation?_id=28304 \nRiskAssessment?_id=28357         \nRiskAssessment?_id=28358         \nHealthcareService?_id=28364    \nHealthcareService?_id=28289    \nHealthcareService?_id=28359    \nOrganization?_id=28295               \nHealthcareService?_id=28414    \nCoverage?_id=28366&_include=Coverage%3Apayor        \nCoverage?_id=28361&_include=Coverage%3Apayor        \nCoverage?_id=28297&_include=Coverage%3Apayor        \nClaim?_id=28367              Claim?_id=28362              \nClaim?_id=28298              \nPatient?_id=CMS2023-patientBSJ1 \n",
  "resource" : [
    "CarePlan"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The Server may wish to enable paging of the output for large bundles.",
      "type" : "Bundle"
    }
  ]
}