Situational Awareness for Novel Epidemic Response
1.0.1 - CI Build International flag

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

CapabilityStatement: Data Source.

Draft as of 2021-07-26

Raw OpenAPI-Swagger Definition file | Download

Data Source.

  • Implementation Guide Version: 1.0.1
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2021-07-26
  • 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

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 TypeProfileRSUCSearches_include_revincludeOperations
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: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLdatedate
SHALLclassreference
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _idreference
 _id+class(+date)reference+reference(+date)

Resource Conformance: SHALL Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLdatedate
SHALLclassreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _idreference
 _id+class(+date)reference+reference(+date)
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL AllergyIntolerance

Core FHIR Resource
AllergyIntolerance
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL DiagnosticReport

Core FHIR Resource
DiagnosticReport
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHOULDsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL FamilyMemberHistory

Core FHIR Resource
FamilyMemberHistory
Reference Policy
Interaction summary
  • SHOULDsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL MedicationAdministration

Core FHIR Resource
MedicationAdministration
Reference Policy
Interaction summary
  • SHOULDsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL MedicationDispense

Core FHIR Resource
MedicationDispense
Reference Policy
Interaction summary
  • SHOULDsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token

Resource Conformance: SHALL MedicationStatement

Core FHIR Resource
MedicationStatement
Reference Policy
Interaction summary
  • SHOULDsupport search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idreference
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
CAPABILITY_COMB_SEARCH_PAR
ConformanceParametersTypes
 _id+patient+encounter+codereference+reference+reference+token