eHealth Infrastructure
2022.1 - release

eHealth Infrastructure - Local Development build (v2022.1). See the Directory of published versions

: Fetch careplans by patient - JSON Representation

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "-s-fetch-careplans-by-patient",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>fetch-careplans-by-patient</h2><p>OPERATION: fetch-careplans-by-patient</p><p>The official URL for this operation definition is: </p><pre>https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-careplans-by-patient</pre><div><h3>Report Contents</h3>\n<p>This report contains the following resources:</p>\n<ul>\n<li>EpisodeOfCare</li>\n<li>PlanDefinition</li>\n<li>CarePlan</li>\n<li>ServiceRequest</li>\n</ul>\n<h3>Grouping</h3>\n<p>This report is grouped by EpisodeOfCare. Each group is returned in a separate JSon file.</p>\n<h3>Parameters</h3>\n<ul>\n<li>organization: Filter on EpisodeOfCare.managingOrganization match</li>\n<li>period: Filter on CarePlan.period overlap</li>\n</ul>\n<h3>Output</h3>\n<p>Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.</p>\n<h3>Example output</h3>\n<p>All returned objects are Fhir resources. See the implementation guide for details</p>\n<pre><code>{\n    'EHealthEpisodeOfCare': {\n        'resourceType': 'EpisodeOfCare',\n        'id': '30254',\n        'meta': {\n            'versionId': '1',\n            'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare']\n        },\n        'extension': [{\n                'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare-caremanagerOrganization',\n                'valueReference': {\n                    'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/88873'\n                }\n            }\n        ],\n        'status': 'active',\n        'diagnosis': [{\n                'condition': {\n                    'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/Condition/66740'\n                },\n                'rank': 1\n            }\n        ],\n        'patient': {\n            'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/18637'\n        },\n        'managingOrganization': {\n            'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/16046'\n        },\n        'period': {\n            'start': '1970-01-01T01:00:01+01:00',\n            'end': '1970-01-01T01:01:40+01:00'\n        }\n    },\n    'EHealthCarePlan': [{\n            'resourceType': 'CarePlan',\n            'id': '1597',\n            'meta': {\n                'versionId': '1',\n                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan']\n            },\n            'definition': [{\n                    'reference': 'https://plan.local.ehealth.sundhed.dk/fhir/PlanDefinition/59578'\n                }\n            ],\n            'status': 'draft',\n            'intent': 'option',\n            'category': [{\n                    'coding': [{\n                            'system': 'http://ehealth.sundhed.dk/cs/careplan-category',\n                            'code': 'TBD'\n                        }\n                    ]\n                }\n            ],\n            'subject': {\n                'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/57779'\n            },\n            'context': {\n                'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/30254'\n            },\n            'period': {\n                'start': '1970-01-01T01:00:01+01:00',\n                'end': '1970-01-01T01:01:40+01:00'\n            },\n            'addresses': [{\n                    'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/Condition/74721'\n                }\n            ],\n            'activity': [{\n                    'reference': {\n                        'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/76916'\n                    }\n                }\n            ]\n        }\n    ],\n    'EHealthPlanDefinition': [{\n            'resourceType': 'PlanDefinition',\n            'id': '59578',\n            'meta': {\n                'versionId': '1',\n                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition']\n            },\n            'extension': [{\n                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role',\n                    'extension': [{\n                            'url': 'reference',\n                            'valueReference': {\n                                'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/41757'\n                            }\n                        }, {\n                            'url': 'role',\n                            'valueCodeableConcept': {\n                                'coding': [{\n                                        'system': 'http://ehealth.sundhed.dk/cs/modifier-role',\n                                        'code': 'owner'\n                                    }\n                                ]\n                            }\n                        }\n                    ]\n                }\n            ],\n            'version': 'c701b8e8-abe6-41bd-9db5-c05b94bc1e2b',\n            'status': 'active'\n        }\n    ],\n    'EHealthServiceRequest': [{\n            'resourceType': 'ServiceRequest',\n            'id': '76916',\n            'meta': {\n                'versionId': '1',\n                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequest']\n            },\n            'extension': [{\n                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy',\n                    'valueCodeableConcept': {\n                        'coding': [{\n                                'system': 'http://ehealth.sundhed.dk/cs/measurement-sharing-policies',\n                                'code': 'TBD'\n                            }\n                        ]\n                    }\n                }\n            ],\n            'definition': [{\n                    'reference': 'https://plan.local.ehealth.sundhed.dk/fhir/ActivityDefinition/13593'\n                }\n            ],\n            'status': 'completed',\n            'intent': 'filler-order',\n            'code': {\n                'coding': [{\n                        'system': 'http://ehealth.sundhed.dk/cs/activitydefinition-code',\n                        'code': 'TBD'\n                    }\n                ],\n                'text': '31d136f2-0b98-4e0a-8f82-f0731b54893d'\n            },\n            'subject': {\n                'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/49397'\n            },\n            'context': {\n                'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/72791'\n            }\n        }\n    ]\n}\n</code></pre>\n</div><p>URL: [base]/$fetch-careplans-by-patient</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</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>IN</td><td>anonymization</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>IN</td><td>organization</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td/></tr><tr><td>IN</td><td>period</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td/><td/></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></td><td/><td/></tr></table></div>"
  },
  "url" : "https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-careplans-by-patient",
  "version" : "2022.1",
  "name" : "fetch-careplans-by-patient",
  "title" : "Fetch careplans by patient",
  "status" : "active",
  "kind" : "operation",
  "date" : "2022-01-18T09:57:29+00:00",
  "publisher" : "Systematic | Trifork",
  "contact" : [
    {
      "name" : "Systematic | Trifork",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://ehealth.sundhed.dk"
        }
      ]
    }
  ],
  "description" : "### Report Contents\nThis report contains the following resources:\n- EpisodeOfCare\n- PlanDefinition\n- CarePlan\n- ServiceRequest\n### Grouping \nThis report is grouped by EpisodeOfCare. Each group is returned in a separate JSon file.\n### Parameters\n- organization: Filter on EpisodeOfCare.managingOrganization match\n- period: Filter on CarePlan.period overlap\n### Output\nOutput can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.\n### Example output\nAll returned objects are Fhir resources. See the implementation guide for details\n\n    {\n        'EHealthEpisodeOfCare': {\n            'resourceType': 'EpisodeOfCare',\n            'id': '30254',\n            'meta': {\n                'versionId': '1',\n                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare']\n            },\n            'extension': [{\n                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare-caremanagerOrganization',\n                    'valueReference': {\n                        'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/88873'\n                    }\n                }\n            ],\n            'status': 'active',\n            'diagnosis': [{\n                    'condition': {\n                        'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/Condition/66740'\n                    },\n                    'rank': 1\n                }\n            ],\n            'patient': {\n                'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/18637'\n            },\n            'managingOrganization': {\n                'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/16046'\n            },\n            'period': {\n                'start': '1970-01-01T01:00:01+01:00',\n                'end': '1970-01-01T01:01:40+01:00'\n            }\n        },\n        'EHealthCarePlan': [{\n                'resourceType': 'CarePlan',\n                'id': '1597',\n                'meta': {\n                    'versionId': '1',\n                    'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan']\n                },\n                'definition': [{\n                        'reference': 'https://plan.local.ehealth.sundhed.dk/fhir/PlanDefinition/59578'\n                    }\n                ],\n                'status': 'draft',\n                'intent': 'option',\n                'category': [{\n                        'coding': [{\n                                'system': 'http://ehealth.sundhed.dk/cs/careplan-category',\n                                'code': 'TBD'\n                            }\n                        ]\n                    }\n                ],\n                'subject': {\n                    'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/57779'\n                },\n                'context': {\n                    'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/30254'\n                },\n                'period': {\n                    'start': '1970-01-01T01:00:01+01:00',\n                    'end': '1970-01-01T01:01:40+01:00'\n                },\n                'addresses': [{\n                        'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/Condition/74721'\n                    }\n                ],\n                'activity': [{\n                        'reference': {\n                            'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/ServiceRequest/76916'\n                        }\n                    }\n                ]\n            }\n        ],\n        'EHealthPlanDefinition': [{\n                'resourceType': 'PlanDefinition',\n                'id': '59578',\n                'meta': {\n                    'versionId': '1',\n                    'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition']\n                },\n                'extension': [{\n                        'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role',\n                        'extension': [{\n                                'url': 'reference',\n                                'valueReference': {\n                                    'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/41757'\n                                }\n                            }, {\n                                'url': 'role',\n                                'valueCodeableConcept': {\n                                    'coding': [{\n                                            'system': 'http://ehealth.sundhed.dk/cs/modifier-role',\n                                            'code': 'owner'\n                                        }\n                                    ]\n                                }\n                            }\n                        ]\n                    }\n                ],\n                'version': 'c701b8e8-abe6-41bd-9db5-c05b94bc1e2b',\n                'status': 'active'\n            }\n        ],\n        'EHealthServiceRequest': [{\n                'resourceType': 'ServiceRequest',\n                'id': '76916',\n                'meta': {\n                    'versionId': '1',\n                    'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequest']\n                },\n                'extension': [{\n                        'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy',\n                        'valueCodeableConcept': {\n                            'coding': [{\n                                    'system': 'http://ehealth.sundhed.dk/cs/measurement-sharing-policies',\n                                    'code': 'TBD'\n                                }\n                            ]\n                        }\n                    }\n                ],\n                'definition': [{\n                        'reference': 'https://plan.local.ehealth.sundhed.dk/fhir/ActivityDefinition/13593'\n                    }\n                ],\n                'status': 'completed',\n                'intent': 'filler-order',\n                'code': {\n                    'coding': [{\n                            'system': 'http://ehealth.sundhed.dk/cs/activitydefinition-code',\n                            'code': 'TBD'\n                        }\n                    ],\n                    'text': '31d136f2-0b98-4e0a-8f82-f0731b54893d'\n                },\n                'subject': {\n                    'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/49397'\n                },\n                'context': {\n                    'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/72791'\n                }\n            }\n        ]\n    }\n",
  "affectsState" : true,
  "code" : "fetch-careplans-by-patient",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "anonymization",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "string"
    },
    {
      "name" : "organization",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Reference"
    },
    {
      "name" : "period",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "Period"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "type" : "Binary"
    }
  ]
}