eHealth Infrastructure


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-fetch-careplans-by-patient"/>
  <text>
    <status value="generated"/>
    <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>http://ehealth.sundhed.dk/fhir/OperationDefinition/-s-fetch-careplans-by-patient</pre><div><h3>Report Contents</h3>
<p>This report contains the following resources:</p>
<ul>
<li>EpisodeOfCare</li>
<li>PlanDefinition</li>
<li>CarePlan</li>
<li>ProcedureRequest</li>
</ul>
<h3>Grouping</h3>
<p>This report is grouped by EpisodeOfCare. Each group is returned in a separate JSon file.</p>
<h3>Parameters</h3>
<ul>
<li>organization: Filter on EpisodeOfCare.managingOrganization match</li>
<li>period: Filter on CarePlan.period overlap</li>
</ul>
<h3>Output</h3>
<p>Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.</p>
<h3>Example output</h3>
<p>All returned objects are Fhir resources. See the implementation guide for details</p>
<pre><code>{
    'EHealthEpisodeOfCare': {
        'resourceType': 'EpisodeOfCare',
        'id': '30254',
        'meta': {
            'versionId': '1',
            'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare']
        },
        'extension': [{
                'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare-caremanagerOrganization',
                'valueReference': {
                    'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/88873'
                }
            }
        ],
        'status': 'active',
        'diagnosis': [{
                'condition': {
                    'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/Condition/66740'
                },
                'rank': 1
            }
        ],
        'patient': {
            'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/18637'
        },
        'managingOrganization': {
            'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/16046'
        },
        'period': {
            'start': '1970-01-01T01:00:01+01:00',
            'end': '1970-01-01T01:01:40+01:00'
        }
    },
    'EHealthCarePlan': [{
            'resourceType': 'CarePlan',
            'id': '1597',
            'meta': {
                'versionId': '1',
                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan']
            },
            'definition': [{
                    'reference': 'https://plan.local.ehealth.sundhed.dk/fhir/PlanDefinition/59578'
                }
            ],
            'status': 'draft',
            'intent': 'option',
            'category': [{
                    'coding': [{
                            'system': 'http://ehealth.sundhed.dk/cs/careplan-category',
                            'code': 'TBD'
                        }
                    ]
                }
            ],
            'subject': {
                'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/57779'
            },
            'context': {
                'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/30254'
            },
            'period': {
                'start': '1970-01-01T01:00:01+01:00',
                'end': '1970-01-01T01:01:40+01:00'
            },
            'addresses': [{
                    'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/Condition/74721'
                }
            ],
            'activity': [{
                    'reference': {
                        'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/ProcedureRequest/76916'
                    }
                }
            ]
        }
    ],
    'EHealthPlanDefinition': [{
            'resourceType': 'PlanDefinition',
            'id': '59578',
            'meta': {
                'versionId': '1',
                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition']
            },
            'extension': [{
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role',
                    'extension': [{
                            'url': 'reference',
                            'valueReference': {
                                'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/41757'
                            }
                        }, {
                            'url': 'role',
                            'valueCodeableConcept': {
                                'coding': [{
                                        'system': 'http://ehealth.sundhed.dk/cs/modifier-role',
                                        'code': 'owner'
                                    }
                                ]
                            }
                        }
                    ]
                }
            ],
            'version': 'c701b8e8-abe6-41bd-9db5-c05b94bc1e2b',
            'status': 'active'
        }
    ],
    'EHealthProcedureRequest': [{
            'resourceType': 'ProcedureRequest',
            'id': '76916',
            'meta': {
                'versionId': '1',
                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-procedurerequest']
            },
            'extension': [{
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy',
                    'valueCodeableConcept': {
                        'coding': [{
                                'system': 'http://ehealth.sundhed.dk/cs/measurement-sharing-policies',
                                'code': 'TBD'
                            }
                        ]
                    }
                }
            ],
            'definition': [{
                    'reference': 'https://plan.local.ehealth.sundhed.dk/fhir/ActivityDefinition/13593'
                }
            ],
            'status': 'completed',
            'intent': 'filler-order',
            'code': {
                'coding': [{
                        'system': 'http://ehealth.sundhed.dk/cs/activitydefinition-code',
                        'code': 'TBD'
                    }
                ],
                'text': '31d136f2-0b98-4e0a-8f82-f0731b54893d'
            },
            'subject': {
                'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/49397'
            },
            'context': {
                'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/72791'
            }
        }
    ]
}
</code></pre>
</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/STU3/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/STU3/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/STU3/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/STU3/binary.html">Binary</a></td><td/><td/></tr></table></div>
  </text>
  <url
       value="http://ehealth.sundhed.dk/fhir/OperationDefinition/-s-fetch-careplans-by-patient"/>
  <name value="fetch-careplans-by-patient"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2020-05-22T12:11:22+00:00"/>
  <description
               value="### Report Contents
This report contains the following resources:
- EpisodeOfCare
- PlanDefinition
- CarePlan
- ProcedureRequest
### Grouping 
This report is grouped by EpisodeOfCare. Each group is returned in a separate JSon file.
### Parameters
- organization: Filter on EpisodeOfCare.managingOrganization match
- period: Filter on CarePlan.period overlap
### Output
Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files corresponding to the report groups.
### Example output
All returned objects are Fhir resources. See the implementation guide for details

    {
        &#39;EHealthEpisodeOfCare&#39;: {
            &#39;resourceType&#39;: &#39;EpisodeOfCare&#39;,
            &#39;id&#39;: &#39;30254&#39;,
            &#39;meta&#39;: {
                &#39;versionId&#39;: &#39;1&#39;,
                &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare&#39;]
            },
            &#39;extension&#39;: [{
                    &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare-caremanagerOrganization&#39;,
                    &#39;valueReference&#39;: {
                        &#39;reference&#39;: &#39;https://organization.local.ehealth.sundhed.dk/fhir/Organization/88873&#39;
                    }
                }
            ],
            &#39;status&#39;: &#39;active&#39;,
            &#39;diagnosis&#39;: [{
                    &#39;condition&#39;: {
                        &#39;reference&#39;: &#39;https://careplan.local.ehealth.sundhed.dk/fhir/Condition/66740&#39;
                    },
                    &#39;rank&#39;: 1
                }
            ],
            &#39;patient&#39;: {
                &#39;reference&#39;: &#39;https://patient.local.ehealth.sundhed.dk/fhir/Patient/18637&#39;
            },
            &#39;managingOrganization&#39;: {
                &#39;reference&#39;: &#39;https://organization.local.ehealth.sundhed.dk/fhir/Organization/16046&#39;
            },
            &#39;period&#39;: {
                &#39;start&#39;: &#39;1970-01-01T01:00:01+01:00&#39;,
                &#39;end&#39;: &#39;1970-01-01T01:01:40+01:00&#39;
            }
        },
        &#39;EHealthCarePlan&#39;: [{
                &#39;resourceType&#39;: &#39;CarePlan&#39;,
                &#39;id&#39;: &#39;1597&#39;,
                &#39;meta&#39;: {
                    &#39;versionId&#39;: &#39;1&#39;,
                    &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan&#39;]
                },
                &#39;definition&#39;: [{
                        &#39;reference&#39;: &#39;https://plan.local.ehealth.sundhed.dk/fhir/PlanDefinition/59578&#39;
                    }
                ],
                &#39;status&#39;: &#39;draft&#39;,
                &#39;intent&#39;: &#39;option&#39;,
                &#39;category&#39;: [{
                        &#39;coding&#39;: [{
                                &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/careplan-category&#39;,
                                &#39;code&#39;: &#39;TBD&#39;
                            }
                        ]
                    }
                ],
                &#39;subject&#39;: {
                    &#39;reference&#39;: &#39;https://patient.local.ehealth.sundhed.dk/fhir/Patient/57779&#39;
                },
                &#39;context&#39;: {
                    &#39;reference&#39;: &#39;https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/30254&#39;
                },
                &#39;period&#39;: {
                    &#39;start&#39;: &#39;1970-01-01T01:00:01+01:00&#39;,
                    &#39;end&#39;: &#39;1970-01-01T01:01:40+01:00&#39;
                },
                &#39;addresses&#39;: [{
                        &#39;reference&#39;: &#39;https://careplan.local.ehealth.sundhed.dk/fhir/Condition/74721&#39;
                    }
                ],
                &#39;activity&#39;: [{
                        &#39;reference&#39;: {
                            &#39;reference&#39;: &#39;https://careplan.local.ehealth.sundhed.dk/fhir/ProcedureRequest/76916&#39;
                        }
                    }
                ]
            }
        ],
        &#39;EHealthPlanDefinition&#39;: [{
                &#39;resourceType&#39;: &#39;PlanDefinition&#39;,
                &#39;id&#39;: &#39;59578&#39;,
                &#39;meta&#39;: {
                    &#39;versionId&#39;: &#39;1&#39;,
                    &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition&#39;]
                },
                &#39;extension&#39;: [{
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role&#39;,
                        &#39;extension&#39;: [{
                                &#39;url&#39;: &#39;reference&#39;,
                                &#39;valueReference&#39;: {
                                    &#39;reference&#39;: &#39;https://organization.local.ehealth.sundhed.dk/fhir/Organization/41757&#39;
                                }
                            }, {
                                &#39;url&#39;: &#39;role&#39;,
                                &#39;valueCodeableConcept&#39;: {
                                    &#39;coding&#39;: [{
                                            &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/modifier-role&#39;,
                                            &#39;code&#39;: &#39;owner&#39;
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                ],
                &#39;version&#39;: &#39;c701b8e8-abe6-41bd-9db5-c05b94bc1e2b&#39;,
                &#39;status&#39;: &#39;active&#39;
            }
        ],
        &#39;EHealthProcedureRequest&#39;: [{
                &#39;resourceType&#39;: &#39;ProcedureRequest&#39;,
                &#39;id&#39;: &#39;76916&#39;,
                &#39;meta&#39;: {
                    &#39;versionId&#39;: &#39;1&#39;,
                    &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-procedurerequest&#39;]
                },
                &#39;extension&#39;: [{
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-sharingPolicy&#39;,
                        &#39;valueCodeableConcept&#39;: {
                            &#39;coding&#39;: [{
                                    &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/measurement-sharing-policies&#39;,
                                    &#39;code&#39;: &#39;TBD&#39;
                                }
                            ]
                        }
                    }
                ],
                &#39;definition&#39;: [{
                        &#39;reference&#39;: &#39;https://plan.local.ehealth.sundhed.dk/fhir/ActivityDefinition/13593&#39;
                    }
                ],
                &#39;status&#39;: &#39;completed&#39;,
                &#39;intent&#39;: &#39;filler-order&#39;,
                &#39;code&#39;: {
                    &#39;coding&#39;: [{
                            &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/activitydefinition-code&#39;,
                            &#39;code&#39;: &#39;TBD&#39;
                        }
                    ],
                    &#39;text&#39;: &#39;31d136f2-0b98-4e0a-8f82-f0731b54893d&#39;
                },
                &#39;subject&#39;: {
                    &#39;reference&#39;: &#39;https://patient.local.ehealth.sundhed.dk/fhir/Patient/49397&#39;
                },
                &#39;context&#39;: {
                    &#39;reference&#39;: &#39;https://careplan.local.ehealth.sundhed.dk/fhir/EpisodeOfCare/72791&#39;
                }
            }
        ]
    }
"/>
  <idempotent value="false"/>
  <code value="fetch-careplans-by-patient"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="anonymization"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="organization"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="period"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Period"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Binary"/>
  </parameter>
</OperationDefinition>