| Package | medicalert.fhir.ig.firstresponder |
| Type | OperationDefinition |
| Id | MedicAlertSummary |
| FHIR Version | R4 |
| Source | https://standards.medicalert.nz/ns/medicalert/https://build.fhir.org/ig/daniel-thomson/medicalert/OperationDefinition-MedicAlertSummary.html |
| URL | https://standards.medicalert.nz/ns/MedicAlertSummary |
| Version | 0.1.0 |
| Status | draft |
| Date | 2022-11-08T13:15:56.964-00:00 |
| Name | MedicAlertPatientSummary |
| Title | MedicAlert Patient Summary |
| Realm | nz |
| Description | The MedicAlert first responder API is queried using a FHIR operation. This is the $summary operation invoked on the Patient resource. The $summary operation returns a set of resources, organized as a Bundle. The response Bundle is structured as a FHIR document that is based on the [IPS standard](https://hl7.org/fhir/uv/ips/). An identifier for the patient (MedicAlert ID or NHI number) must be provided along with a reason for the API access. ### Querying the API The $summary operation must be invoked as a POST with the parameters passed in the message body. An example query for emergency access using an NHI number: ``` POST [base]/Patient/$summary Content-Type: application/x-www-form-urlencoded _identifier=https://standards.digital.health.nz/ns/nhi%7CZZZ0016&reason=EmergencyAccess ``` An example query for non emergency access using the MedicAlert id: ``` POST [base]/Patient/$summary Content-Type: application/x-www-form-urlencoded _identifier=https://standards.medicalert.nz/memberId%7C1001&reason=NonEmergencyAccess ``` An example query for emergency access using an accessKey: ``` POST [base]/Patient/$summary Content-Type: application/x-www-form-urlencoded _identifier=https://standards.medicalert.nz/accessKey%7C10011XX1&reason=EmergencyAccess ``` (note that non-standard ASCII characters such as the | character must be URL encoded - in this case as %7C) |
| Type | true |
| Kind | query |
| CapabilityStatement | |
| MedicAlert-FirstResponderAPI | MedicAlert IPS Server Capability Statement |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition MedicAlertSummary
URL: [base]/Patient/$summary
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | identifer | 1..1 | Identifier | Either the MedicAlert Member ID, valid NHI number, or valed accessKey must be provided. This should be provided as the identifier system URI followed by the id, seperated by a pipe character | ||
| IN | reason | 1..1 | Coding | MedicAlert Access Reason ValueSet (Required) | The reason/context that the service is accessed for | |
| OUT | return | 0..1 | Bundle | The Bundle returned is a patient summary conforming to the MedicAlert Patient Summary bundle (if not otherwise specified) |
FHIR{
"resourceType": "OperationDefinition",
"id": "MedicAlertSummary",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "https://standards.medicalert.nz/ns/MedicAlertSummary",
"version": "0.1.0",
"name": "MedicAlertPatientSummary",
"title": "MedicAlert Patient Summary",
"status": "draft",
"kind": "query",
"date": "2022-11-08T13:15:56.964-00:00",
"publisher": "MedicAlert",
"contact": [
{
"name": "MedicAlert",
"telecom": [
{
"system": "url",
"value": "https://medicalert.nz/"
}
]
}
],
"description": "The MedicAlert first responder API is queried using a FHIR operation. This is the $summary operation invoked on the Patient resource. The $summary operation returns a set of resources, organized as a Bundle. \n\nThe response Bundle is structured as a FHIR document that is based on the [IPS standard](https://hl7.org/fhir/uv/ips/). \n\nAn identifier for the patient (MedicAlert ID or NHI number) must be provided along with a reason for the API access. \n\n### Querying the API\n\nThe $summary operation must be invoked as a POST with the parameters passed in the message body.\n\nAn example query for emergency access using an NHI number:\n```\nPOST [base]/Patient/$summary\nContent-Type: application/x-www-form-urlencoded\n\n_identifier=https://standards.digital.health.nz/ns/nhi%7CZZZ0016&reason=EmergencyAccess\n```\nAn example query for non emergency access using the MedicAlert id:\n```\nPOST [base]/Patient/$summary\nContent-Type: application/x-www-form-urlencoded\n\n_identifier=https://standards.medicalert.nz/memberId%7C1001&reason=NonEmergencyAccess\n```\nAn example query for emergency access using an accessKey:\n```\nPOST [base]/Patient/$summary\nContent-Type: application/x-www-form-urlencoded\n\n_identifier=https://standards.medicalert.nz/accessKey%7C10011XX1&reason=EmergencyAccess\n```\n\n\n(note that non-standard ASCII characters such as the | character must be URL encoded - in this case as %7C)",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "NZ",
"display": "New Zealand"
}
]
}
],
"affectsState": false,
"code": "summary",
"resource": [
"Patient"
],
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "identifer",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Either the MedicAlert Member ID, valid NHI number, or valed accessKey must be provided. This should be provided as the identifier system URI followed by the id, seperated by a pipe character",
"type": "Identifier"
},
{
"name": "reason",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The reason/context that the service is accessed for",
"type": "Coding",
"binding": {
"strength": "required",
"valueSet": "https://standards.medicalert.nz/ValueSet/AccessReason"
}
},
{
"name": "return",
"use": "out",
"min": 0,
"max": "1",
"documentation": "The Bundle returned is a patient summary conforming to the [MedicAlert Patient Summary bundle](https://standards.medicalert.nz/MedicAlertPatientSummaryBundle) (if not otherwise specified)",
"type": "Bundle"
}
]
}