FirstResponder API
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.
To query the API 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-id|ZZZ0016&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/ns/memberId|1001&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/ns/accessKey|10011XX1&reason=EmergencyAccess
(note that non-standard ASCII characters such as the pipe character before the identifier may need to be URL encoded - in this case | would be encoded as %7C)
Operation Parameters (In)
Name | Cardinality | Type | Binding | Documentation |
---|---|---|---|---|
identifer | 1..1 | Identifier | Either the MedicAlert Member ID, valid NHI number, or member's access key must be provided. This should be provided as the identifier system URI followed by the id, seperated by a pipe character | |
reason | 1..1 | Coding | https://standards.medicalert.nz/ValueSet/AccessReason (required) | The reason/context that the service is accessed for |
Operation Return Values (Out)
Name | Cardinality | Type | Documentation |
---|---|---|---|
return | 0..1 | Bundle | The Bundle returned is a patient summary conforming to the MedicAlert Patient Summary Bundle |
Access Reason parameter codes
- Include all codes defined in
https://standards.medicalert.nz/CodeSystem/AccessReason
This code system https://standards.medicalert.nz/CodeSystem/AccessReason
defines the following codes:
Code | Display |
Test | For testing usage only |
EmergencyAccess | Emergency Access |
NonEmergencyAccess | Non Emergency Access |
Accident | Accident |
MedicAlertSummary OperationDefinition profile:
Canonical URL: https://standards.medicalert.nz/ns/MedicAlertSummary
Differential View
OperationDefinition |
id : MedicAlertSummary |
text |
status : extensions |
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. 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) |
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 |
parameter |
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 |
parameter |
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 |
Hybrid View
OperationDefinition |
id : MedicAlertSummary |
text |
status : extensions |
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. 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) |
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 |
parameter |
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 |
parameter |
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 |
Snapshot View
OperationDefinition |
id : MedicAlertSummary |
text |
status : extensions |
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. 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) |
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 |
parameter |
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 |
parameter |
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 |