INTEROPen
0. References
HL7 UK | Care Connect Profile: - |
HL7 FHIR Resource: Flag |
1. Read
Return a single Flag for the specified id
2. Search Parameters
Search for all flag (alert) resources for a patient. Fetches a bundle of all Flag resources for the specified patient.
This implementation guide outlines some suggested search parameters for the Flag resource in the table below. To be conformant, provider systems are required to implement all of the SHALL parameters. Provider systems may implement the full list of search parameters for the Flag resource (HL7 FHIR STU3 Flag).
| Name | Type | Description | SHALL | Path |
|---|---|---|---|---|
date |
date |
Time period when flag is active | Flag.period | |
patient |
reference |
The patient for the vaccination record | Y | Flag.subject (Patient) |
status |
token |
Flag status: active, inactive or entered-in-error | Y | Flag.status |
2.1. patient
See reference for details on this parameter. The patient parameter can be used two ways:
This SHALL be supported for all endpoint provider systems.
id is the logical id of the patient on the server which can be obtained by a Patient resource query.
GET [baseUrl]/Flag?patient=42
Return all Flag resources for Patients with a logical id of 42This SHOULD be supported by middleware systems (e.g. enterprise application integration (EAI) and the enterprise service bus (ESB)) and MAY be supported for endpoint provider systems.
system is a uniform resource identifier which defines which CodeSystem the identifer belongs to. For NHS Number this would be https://fhir.nhs.uk/Id/nhs-number and code would be the NHS Number.
GET [baseUrl]/Flag?patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
Return all Flag resources for Patients with a NHS Number of 98765432102.2. status
See token for details on this parameter.
To filter on status ( active | inactive | entered-in-error )
GET [baseUrl]/Flag?patient=1&status=active
Return all Flag resources with a status of active and Patient with a logical id of 1.