Situational Awareness for Novel Epidemic Response, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-saner/ and changes regularly. See the Directory of published versions
Measure Computer implementing the Compute Measure transaction.
- Implementation Guide Version: 1.0.1
- FHIR Version: 4.0.1
- Supported Formats:
xml
, json
- Supported Patch Formats:
- Published on: Mon Jul 26 00:00:00 UTC 2021
- Published by: HL7 International / Public Health
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
FHIR RESTful Capabilities
REST Configuration 1
Mode: client
Summary of System-wide Interactions
Capabilities by Resource/Profile
Summary
The summary table lists the resources that are part of this configuration, and for each resource it lists:
- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for
_include
- The other resources enabled for
_revinclude
- The operations on the resource (if any)
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|
Measure | | | | | | | | | |
Patient | | | y | | | _id, date, class | | | |
Encounter | | | y | | | _id, date, class, patient, encounter, code | | | |
AllergyIntolerance | | | y | | | _id, patient, encounter, code | | | |
Condition | | | y | | | _id, patient, encounter, code | | | |
DiagnosticReport | | | y | | | _id, patient, encounter, code | | | |
MedicationRequest | | | y | | | _id, patient, encounter, code | | | |
Observation | | | y | | | _id, patient, encounter, code | | | |
Procedure | | | y | | | _id, patient, encounter, code | | | |
ServiceRequest | | | y | | | _id, patient, encounter, code | | | |
DocumentReference | | | y | | | _id, patient, encounter, code | | | |
FamilyMemberHistory | | | y | | | _id, patient, encounter, code | | | |
MedicationAdministration | | | y | | | _id, patient, encounter, code | | | |
MedicationDispense | | | y | | | _id, patient, encounter, code | | | |
MedicationStatement | | | y | | | _id, patient, encounter, code | | | |
Resource Conformance: supportedMeasure
Resource Conformance: SHALLPatient
Reference Policy
Interaction summary- SHALL support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | class | reference | |
MAY | date | date | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id | reference |
| _id+class(+date) | reference +reference (+date ) |
Resource Conformance: SHALLEncounter
Reference Policy
Interaction summary- SHALL support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | class | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
MAY | date | date | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id | reference |
| _id+class(+date) | reference +reference (+date ) |
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLAllergyIntolerance
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLCondition
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLDiagnosticReport
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLMedicationRequest
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLObservation
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLProcedure
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLServiceRequest
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLDocumentReference
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLFamilyMemberHistory
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLMedicationAdministration
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLMedicationDispense
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
Resource Conformance: SHALLMedicationStatement
Reference Policy
Interaction summary- SHOULD support
search-type
.
Search ParametersConformance | Parameter | Type | Documentation |
---|
SHALL | _id | reference | |
SHALL | patient | reference | |
SHALL | encounter | reference | |
SHALL | code | token | |
Combined Search ParametersConformance | Parameters | Types |
---|
| _id+patient+encounter+code | reference +reference +reference +token |
REST Configuration 2
Mode: server
Summary of System-wide Interactions
Capabilities by Resource/Profile
Summary
The summary table lists the resources that are part of this configuration, and for each resource it lists:
- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for
_include
- The other resources enabled for
_revinclude
- The operations on the resource (if any)
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|
Measure | | | | | | | | | |
Resource Conformance: supportedMeasure