Package | dk.ehealth.sundhed.fhir.ig.core |
Resource Type | OperationDefinition |
Id | ehealth-person-match |
FHIR Version | R4 |
Source | http://ehealth.sundhed.dk/fhir/https://build.fhir.org/ig/fut-infrastructure/implementation-guide/OperationDefinition-ehealth-person-match.html |
URL | http://ehealth.sundhed.dk/fhir/OperationDefinition/ehealth-person-match |
Version | 3.5.1 |
Status | active |
Date | 2019-10-16 |
Name | Person name lookup |
Realm | dk |
Description | This operation is used to lookup a citizen. It first attempts lookup on the service and, if a match is found, returns a Person resource with name, identifier, deceased-status and a link to the Patient resource. If not, it proceeds to find any prior CPR-numbers associated with the query CPR in the national infrastructure and checks if any of those match a patient on the service. If a match is found, it returns a Person resource with the same information. NOTE: This means that the returned patient can have a different identifier than the one used for request. If no match is found, it finds base information on the national infrastructure and returns a 'limited' Person resource containing only the identifier, name and deceased-state of the person. The operation is an implementation of [https://www.hl7.org/fhir/stu3/patient-operations.html#match](https://www.hl7.org/fhir/stu3/patient-operations.html#match) on the Person resource. |
Type | true |
Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: Operationsdefinition ehealth-person-match
URL: [base]/Person/$match
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | resource | 1..1 | Person | The social security number of the person on which this operation is executed, wrapped in a Person. If the person exists in the infrastructure a link to the patient is provided | ||
OUT | return | 1..1 | Bundle | A bundle containing a set of Person records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in person fragment - check against profile) Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource. |
{ "resourceType": "OperationDefinition", "id": "ehealth-person-match", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "url": "http://ehealth.sundhed.dk/fhir/OperationDefinition/ehealth-person-match", "version": "3.5.1", "name": "Person name lookup", "status": "active", "kind": "operation", "date": "2019-10-16", "publisher": "Den telemedicinske infrastruktur (eHealth Infrastructure)", "contact": [ { "name": "Den telemedicinske infrastruktur (eHealth Infrastructure)", "telecom": [ { "system": "url", "value": "http://ehealth.sundhed.dk" } ] } ], "description": "This operation is used to lookup a citizen. It first attempts lookup on the service and, if a match is found, returns a Person resource with name, identifier, deceased-status and a link to the Patient resource. If not, it proceeds to find any prior CPR-numbers associated with the query CPR in the national infrastructure and checks if any of those match a patient on the service. If a match is found, it returns a Person resource with the same information. NOTE: This means that the returned patient can have a different identifier than the one used for request. If no match is found, it finds base information on the national infrastructure and returns a 'limited' Person resource containing only the identifier, name and deceased-state of the person. The operation is an implementation of [https://www.hl7.org/fhir/stu3/patient-operations.html#match](https://www.hl7.org/fhir/stu3/patient-operations.html#match) on the Person resource.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "DK", "display": "Denmark" } ] } ], "affectsState": true, "code": "match", "resource": [ "Person" ], "system": false, "type": true, "instance": false, "parameter": [ { "name": "resource", "use": "in", "min": 1, "max": "1", "documentation": "The social security number of the person on which this operation is executed, wrapped in a Person. If the person exists in the infrastructure a link to the patient is provided", "type": "Person" }, { "name": "return", "use": "out", "min": 1, "max": "1", "documentation": "A bundle containing a set of Person records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in person fragment - check against profile) Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource.", "type": "Bundle" } ] }