Procedure
Search Parameters
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the CapabilityStatements of this guide for a complete list of supported RESTful interactions.
FHIR search operations are described in the FHIR specification. Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| patient | SHALL | reference | The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
| patient+date | SHALL | reference+date | |
| patient+code+date | SHOULD | reference+token+date | |
| patient+status | SHOULD | reference+token | |
| code | MAY | token | The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHOULD support multipleOr. The responder SHOULD support multipleOr. |
| date | MAY | date | The requester SHALL provide a value precise to the second + time offset. The responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators gt, lt, ge, le. The responder SHALL support these search comparators gt, lt, ge, le. The requester SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le. The responder SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le. |
| status | MAY | token | The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support multipleOr. The responder SHALL support multipleOr. |
Mandatory Search Parameters
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching using the patient search parameter:
- SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
GET [base]/Procedure?patient={Type/}[id]
SHALL support searching using the combination of the patient and date search parameters:
- SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
- SHALL support a value precise to the second + time offset.
- SHALL support these search comparators gt, lt, ge, le.
- SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.
GET [base]/Procedure?patient={Type/}[id]&date={gt|lt|ge|le}[date]
Optional Search Parameters
The following search parameters and search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient and code and date search parameters:
- SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
- SHOULD support multipleOr.
- SHALL support a value precise to the second + time offset.
- SHALL support these search comparators gt, lt, ge, le.
- SHOULD support multipleAnd, and if multipleAnd is supported, SHALL support the search comparators gt, lt, ge, le.
GET [base]/Procedure?patient={Type/}[id]&code={system|}[code]&date={gt|lt|ge|le}[date]
SHOULD support searching using the combination of the patient and status search parameters:
- SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
- SHALL support multipleOr.
GET [base]/Procedure?patient={Type/}[id]&status={system|}[code]
Examples
Example requests and implementation notes for this profile (hand-written).