DK.EHEALTH.SUNDHED.FHIR.IG.CORE\Fetch patient devices - XML Representation

eHealth Infrastructure
2021.3.0 - build
eHealth Infrastructure - Local Development build (v2021.3.0). See the Directory of published versions
: Fetch patient devices - XML Representation



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="-s-fetch-patient-devices"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>fetch-patient-devices</h2><p>OPERATION: fetch-patient-devices</p><p>The official URL for this operation definition is: </p><pre>https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-patient-devices</pre><div><h3>Report Contents</h3>
<p>This report contains Device information for each EpisodeOfCare:</p>
<ul>
<li>Device</li>
<li>DeviceUseStatement</li>
<li>DeviceMetrics</li>
</ul>
<h3>Grouping</h3>
<p>This report is grouped by EpsiodeOfCare. 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 DeviceUseStatement.whenUsed 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': 'F417C17F9FDE24C9090BD629C8EE1697',
        '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/313D8B0E0AC8EA8169D1DA45ECEEACB9'
                }
            }
        ],
        'status': 'active',
        'diagnosis': [{
                'condition': {
                    'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/Condition/9A7FCD55CA3031585A8F1690DB1D8034'
                },
                'rank': 1
            }
        ],
        'patient': {
            'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/A1D94F323D8EF09E5D913D9522FD83C4'
        },
        'managingOrganization': {
            'reference': 'https://organization.local.ehealth.sundhed.dk/fhir/Organization/8DC75F2B12BCC832F92CC065C3D0B451'
        },
        'period': {
            'start': '1970-01-01T01:00:01+01:00',
            'end': '1970-01-01T01:01:40+01:00'
        }
    },
    'EHealthDeviceUseStatement': [{
            'resourceType': 'DeviceUseStatement',
            'id': '9541E8EAEAD24376F208D5CD8A4D25F5',
            'meta': {
                'versionId': '1',
                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-deviceusestatement']
            },
            'extension': [{
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-deviceusestatement-context',
                    'valueReference': {
                        'reference': 'https://careplan.local.ehealth.sundhed.dk/fhir/CarePlan/23D34B29DD02EB232B6575537FE8ADC5'
                    }
                }
            ],
            'status': 'active',
            'subject': {
                'reference': 'https://patient.local.ehealth.sundhed.dk/fhir/Patient/AC38B1F6391F256002E5A7BE69CB2586'
            },
            'device': {
                'reference': 'https://device.local.ehealth.sundhed.dk/fhir/Device/08D51B81A7FE5B480278150A94D4048A'
            }
        }
    ],
    'EHealthDevice': [{
            'resourceType': 'Device',
            'id': '08D51B81A7FE5B480278150A94D4048A',
            'meta': {
                'versionId': '1',
                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device']
            },
            'extension': [{
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned',
                    'valueBoolean': true
                }
            ],
            'status': 'active'
        }
    ],
    'EHealthDeviceMetric': [{
            'resourceType': 'DeviceMetric',
            'id': '7EA21ACD27EE012439F1440574A6BB21',
            'meta': {
                'versionId': '1',
                'profile': ['http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric']
            },
            'extension': [{
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities',
                    'extension': [{
                            'url': 'category',
                            'valueCodeableConcept': {
                                'coding': [{
                                        'system': 'http://ehealth.sundhed.dk/cs/devicemetric-quality-types',
                                        'code': 'initial'
                                    }
                                ]
                            }
                        }, {
                            'url': 'value',
                            'valueInteger': 5
                        }
                    ]
                }, {
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities',
                    'extension': [{
                            'url': 'category',
                            'valueCodeableConcept': {
                                'coding': [{
                                        'system': 'http://ehealth.sundhed.dk/cs/devicemetric-quality-types',
                                        'code': 'initial'
                                    }
                                ]
                            }
                        }, {
                            'url': 'value',
                            'valueInteger': 10
                        }
                    ]
                }, {
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities',
                    'extension': [{
                            'url': 'category',
                            'valueCodeableConcept': {
                                'coding': [{
                                        'system': 'http://ehealth.sundhed.dk/cs/devicemetric-quality-types',
                                        'code': 'initial'
                                    }
                                ]
                            }
                        }, {
                            'url': 'value',
                            'valueInteger': 12
                        }
                    ]
                }, {
                    'url': 'http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities',
                    'extension': [{
                            'url': 'category',
                            'valueCodeableConcept': {
                                'coding': [{
                                        'system': 'http://ehealth.sundhed.dk/cs/devicemetric-quality-types',
                                        'code': 'initial'
                                    }
                                ]
                            }
                        }, {
                            'url': 'value',
                            'valueInteger': 14
                        }
                    ]
                }
            ],
            'identifier': {
                'value': 'Foo'
            },
            'type': {
                'text': 'code'
            },
            'source': {
                'reference': 'https://device.local.ehealth.sundhed.dk/fhir/Device/08D51B81A7FE5B480278150A94D4048A'
            },
            'category': 'calculation'
        }
    ]
}
</code></pre>
</div><p>URL: [base]/$fetch-patient-devices</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>IN</td><td>devicetype</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Coding">Coding</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>
  </text>
  <url
       value="https://reporting.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-fetch-patient-devices"/>
  <version value="2021.3.0"/>
  <name value="fetch-patient-devices"/>
  <title value="Fetch patient devices"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2021-11-25T09:32:14+00:00"/>
  <publisher value="Systematic | Trifork"/>
  <contact>
    <name value="Systematic | Trifork"/>
    <telecom>
      <system value="url"/>
      <value value="http://ehealth.sundhed.dk"/>
    </telecom>
  </contact>
  <description
               value="### Report Contents
This report contains Device information for each EpisodeOfCare:
- Device
- DeviceUseStatement
- DeviceMetrics
### Grouping 
This report is grouped by EpsiodeOfCare. Each group is returned in a separate JSon file.
### Parameters
- organization: Filter on EpisodeOfCare.managingOrganization match
- period: Filter on DeviceUseStatement.whenUsed 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;F417C17F9FDE24C9090BD629C8EE1697&#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/313D8B0E0AC8EA8169D1DA45ECEEACB9&#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/9A7FCD55CA3031585A8F1690DB1D8034&#39;
                    },
                    &#39;rank&#39;: 1
                }
            ],
            &#39;patient&#39;: {
                &#39;reference&#39;: &#39;https://patient.local.ehealth.sundhed.dk/fhir/Patient/A1D94F323D8EF09E5D913D9522FD83C4&#39;
            },
            &#39;managingOrganization&#39;: {
                &#39;reference&#39;: &#39;https://organization.local.ehealth.sundhed.dk/fhir/Organization/8DC75F2B12BCC832F92CC065C3D0B451&#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;EHealthDeviceUseStatement&#39;: [{
                &#39;resourceType&#39;: &#39;DeviceUseStatement&#39;,
                &#39;id&#39;: &#39;9541E8EAEAD24376F208D5CD8A4D25F5&#39;,
                &#39;meta&#39;: {
                    &#39;versionId&#39;: &#39;1&#39;,
                    &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-deviceusestatement&#39;]
                },
                &#39;extension&#39;: [{
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-deviceusestatement-context&#39;,
                        &#39;valueReference&#39;: {
                            &#39;reference&#39;: &#39;https://careplan.local.ehealth.sundhed.dk/fhir/CarePlan/23D34B29DD02EB232B6575537FE8ADC5&#39;
                        }
                    }
                ],
                &#39;status&#39;: &#39;active&#39;,
                &#39;subject&#39;: {
                    &#39;reference&#39;: &#39;https://patient.local.ehealth.sundhed.dk/fhir/Patient/AC38B1F6391F256002E5A7BE69CB2586&#39;
                },
                &#39;device&#39;: {
                    &#39;reference&#39;: &#39;https://device.local.ehealth.sundhed.dk/fhir/Device/08D51B81A7FE5B480278150A94D4048A&#39;
                }
            }
        ],
        &#39;EHealthDevice&#39;: [{
                &#39;resourceType&#39;: &#39;Device&#39;,
                &#39;id&#39;: &#39;08D51B81A7FE5B480278150A94D4048A&#39;,
                &#39;meta&#39;: {
                    &#39;versionId&#39;: &#39;1&#39;,
                    &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device&#39;]
                },
                &#39;extension&#39;: [{
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-device-privatelyOwned&#39;,
                        &#39;valueBoolean&#39;: true
                    }
                ],
                &#39;status&#39;: &#39;active&#39;
            }
        ],
        &#39;EHealthDeviceMetric&#39;: [{
                &#39;resourceType&#39;: &#39;DeviceMetric&#39;,
                &#39;id&#39;: &#39;7EA21ACD27EE012439F1440574A6BB21&#39;,
                &#39;meta&#39;: {
                    &#39;versionId&#39;: &#39;1&#39;,
                    &#39;profile&#39;: [&#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric&#39;]
                },
                &#39;extension&#39;: [{
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-qualities&#39;,
                        &#39;extension&#39;: [{
                                &#39;url&#39;: &#39;category&#39;,
                                &#39;valueCodeableConcept&#39;: {
                                    &#39;coding&#39;: [{
                                            &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/devicemetric-quality-types&#39;,
                                            &#39;code&#39;: &#39;initial&#39;
                                        }
                                    ]
                                }
                            }, {
                                &#39;url&#39;: &#39;value&#39;,
                                &#39;valueInteger&#39;: 5
                            }
                        ]
                    }, {
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities&#39;,
                        &#39;extension&#39;: [{
                                &#39;url&#39;: &#39;category&#39;,
                                &#39;valueCodeableConcept&#39;: {
                                    &#39;coding&#39;: [{
                                            &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/devicemetric-quality-types&#39;,
                                            &#39;code&#39;: &#39;initial&#39;
                                        }
                                    ]
                                }
                            }, {
                                &#39;url&#39;: &#39;value&#39;,
                                &#39;valueInteger&#39;: 10
                            }
                        ]
                    }, {
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities&#39;,
                        &#39;extension&#39;: [{
                                &#39;url&#39;: &#39;category&#39;,
                                &#39;valueCodeableConcept&#39;: {
                                    &#39;coding&#39;: [{
                                            &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/devicemetric-quality-types&#39;,
                                            &#39;code&#39;: &#39;initial&#39;
                                        }
                                    ]
                                }
                            }, {
                                &#39;url&#39;: &#39;value&#39;,
                                &#39;valueInteger&#39;: 12
                            }
                        ]
                    }, {
                        &#39;url&#39;: &#39;http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-devicemetric-templateQualities&#39;,
                        &#39;extension&#39;: [{
                                &#39;url&#39;: &#39;category&#39;,
                                &#39;valueCodeableConcept&#39;: {
                                    &#39;coding&#39;: [{
                                            &#39;system&#39;: &#39;http://ehealth.sundhed.dk/cs/devicemetric-quality-types&#39;,
                                            &#39;code&#39;: &#39;initial&#39;
                                        }
                                    ]
                                }
                            }, {
                                &#39;url&#39;: &#39;value&#39;,
                                &#39;valueInteger&#39;: 14
                            }
                        ]
                    }
                ],
                &#39;identifier&#39;: {
                    &#39;value&#39;: &#39;Foo&#39;
                },
                &#39;type&#39;: {
                    &#39;text&#39;: &#39;code&#39;
                },
                &#39;source&#39;: {
                    &#39;reference&#39;: &#39;https://device.local.ehealth.sundhed.dk/fhir/Device/08D51B81A7FE5B480278150A94D4048A&#39;
                },
                &#39;category&#39;: &#39;calculation&#39;
            }
        ]
    }
"/>
  <affectsState value="true"/>
  <code value="fetch-patient-devices"/>
  <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="devicetype"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Coding"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Binary"/>
  </parameter>
</OperationDefinition>
Links: Table of Contents | QA Report | Change log