eHealth Infrastructure
3.1.0 - release

This page is part of the FUT Infrastructure (v3.1.0: Release) 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

: Execute careplans by patient - XML Representation

Active as of 2024-07-01

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-execute-careplans-by-patient"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition -s-execute-careplans-by-patient</b></p><a name="-s-execute-careplans-by-patient"> </a><a name="hc-s-execute-careplans-by-patient"> </a><a name="hc-s-execute-careplans-by-patient-en-US"> </a><p>URL: [base]/$execute-careplans-by-patient</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>IN</td><td>anonymization</td><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/><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/><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/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/binary.html">Binary</a></td><td/><td/></tr></table></div>
  </text>
  <url
       value="https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-execute-careplans-by-patient"/>
  <version value="3.1.0"/>
  <name value="execute-careplans-by-patient"/>
  <title value="Execute careplans by patient"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2024-07-01T11:04:33+00:00"/>
  <publisher
             value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
  <contact>
    <name value="Den telemedicinske infrastruktur (eHealth Infrastructure)"/>
    <telecom>
      <system value="url"/>
      <value value="http://ehealth.sundhed.dk"/>
    </telecom>
  </contact>
  <description
               value="### Report Contents
This report contains the following resources:
- EpisodeOfCare
- PlanDefinition
- CarePlan
- ServiceRequest
### 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

    {
        '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/ServiceRequest/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'
            }
        ],
        'EHealthServiceRequest': [{
                'resourceType': 'ServiceRequest',
                'id': '76916',
                'meta': {
                    'versionId': '1',
                    'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequest']
                },
                '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'
                }
            }
        ]
    }
"/>
  <affectsState value="true"/>
  <code value="execute-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>