FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/all-eltss-careplan

Packagehl7.fhir.us.eltss
TypeOperationDefinition
Idall-eltss-careplan
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/eltss/https://build.fhir.org/ig/HL7/eLTSS/OperationDefinition-all-eltss-careplan.html
URLhttp://hl7.org/fhir/us/eltss/OperationDefinition/all-eltss-careplan
Version2.0.0
Statusdraft
Date2024-05-23T18:52:32+00:00
NameAllEltssCareplan
TitleAll Eltss Careplan
Realmus
Authorityhl7
DescriptionProvide 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.
Typefalse
Kindoperation

Resources that use this resource

CapabilityStatement
eltss-servereLTSS Server Capability Statement

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

URL: [base]/CarePlan/[id]/$all-eltss-careplan

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
OUTreturn1..1Bundle

The Server may wish to enable paging of the output for large bundles.

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 &_include=CarePlan%3Aactivity-reference

&_include=CarePlan%3Acare-team

&_include=CarePlan%3Acondition

&_include=CarePlan%3Aencounter

&_include=CarePlan%3Agoal

&_include=CarePlan%3Aperformer

&_include=CarePlan%3Asubject

&_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&_include=Coverage%3Apayor
Coverage?_id=28361&_include=Coverage%3Apayor
Coverage?_id=28297&_include=Coverage%3Apayor
Claim?_id=28367 Claim?_id=28362
Claim?_id=28298
Patient?_id=CMS2023-patientBSJ1


Source

{
  "resourceType": "OperationDefinition",
  "id": "all-eltss-careplan",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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-23T18:52:32+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"
    }
  ]
}