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.
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/1001&reason=NonEmergencyAccess
(note that non-standard ASCII characters such as the '|' character must be URL encoded)
Operation Parameters (In)
| Name | Cardinality | Type | Binding | Documentation |
|---|---|---|---|---|
| identifer | 1..1 | Identifier | Either the MedicAlert Member ID or a valid NHI number 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/MedicAlertSummary
Differential View
| OperationDefinition |
| id : MedicAlertSummary |
| text |
| status : extensions |
| url : https://standards.medicalert.nz/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 : Te Whatu Ora |
| contact |
| name : Te Whatu Ora |
| telecom |
| system : url |
| value : https://www.tewhatuora.govt.nz/ |
| description : This operation is used to return a patient summary from MedicAlert which is based on the International Patient Summary profiles. An identifier for the patient (MedicAlert ID or NHI number) must be provided along with a reason for the API access. The $summary operation must be invoked as a POST with the parameters passed in the message body E.g.: ``` POST [base]/Patient/$summary Content-Type: application/x-www-form-urlencoded _identifier=https://standards.digital.health.nz/ns/nhi%7CZZZ0016&reason=EmergencyAccess ``` Note that the '|' character must be URL encoded 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 or a valid NHI number 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 document conforming to the specified input profile parameter or the International Patient Summary [Bundle profile](./StructureDefinition-Bundle-uv-ips.html) (if not otherwise specified) |
| type : Bundle |
Hybrid View
| OperationDefinition |
| id : MedicAlertSummary |
| text |
| status : extensions |
| url : https://standards.medicalert.nz/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 : Te Whatu Ora |
| contact |
| name : Te Whatu Ora |
| telecom |
| system : url |
| value : https://www.tewhatuora.govt.nz/ |
| description : This operation is used to return a patient summary from MedicAlert which is based on the International Patient Summary profiles. An identifier for the patient (MedicAlert ID or NHI number) must be provided along with a reason for the API access. The $summary operation must be invoked as a POST with the parameters passed in the message body E.g.: ``` POST [base]/Patient/$summary Content-Type: application/x-www-form-urlencoded _identifier=https://standards.digital.health.nz/ns/nhi%7CZZZ0016&reason=EmergencyAccess ``` Note that the '|' character must be URL encoded 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 or a valid NHI number 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 document conforming to the specified input profile parameter or the International Patient Summary [Bundle profile](./StructureDefinition-Bundle-uv-ips.html) (if not otherwise specified) |
| type : Bundle |
Snapshot View
| OperationDefinition |
| id : MedicAlertSummary |
| text |
| status : extensions |
| url : https://standards.medicalert.nz/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 : Te Whatu Ora |
| contact |
| name : Te Whatu Ora |
| telecom |
| system : url |
| value : https://www.tewhatuora.govt.nz/ |
| description : This operation is used to return a patient summary from MedicAlert which is based on the International Patient Summary profiles. An identifier for the patient (MedicAlert ID or NHI number) must be provided along with a reason for the API access. The $summary operation must be invoked as a POST with the parameters passed in the message body E.g.: ``` POST [base]/Patient/$summary Content-Type: application/x-www-form-urlencoded _identifier=https://standards.digital.health.nz/ns/nhi%7CZZZ0016&reason=EmergencyAccess ``` Note that the '|' character must be URL encoded 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 or a valid NHI number 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 document conforming to the specified input profile parameter or the International Patient Summary [Bundle profile](./StructureDefinition-Bundle-uv-ips.html) (if not otherwise specified) |
| type : Bundle |
Examples
Command 'pagelink' could not render: Page not found.