Data Source.

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

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

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	S	Searches
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: SHALLPatient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	date	`date`
SHALL	class	`reference`

Combined Search Parameters

Conformance	Parameters	Types
	_id	`reference`
	_id+class(+date)	`reference`+`reference`(+`date`)

Resource Conformance: SHALLEncounter

Core FHIR Resource
Encounter

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	date	`date`
SHALL	class	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id	`reference`
	_id+class(+date)	`reference`+`reference`(+`date`)
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLAllergyIntolerance

Core FHIR Resource
AllergyIntolerance

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLCondition

Core FHIR Resource
Condition

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLDiagnosticReport

Core FHIR Resource
DiagnosticReport

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLMedicationRequest

Core FHIR Resource
MedicationRequest

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLObservation

Core FHIR Resource
Observation

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLProcedure

Core FHIR Resource
Procedure

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLServiceRequest

Core FHIR Resource
ServiceRequest

Reference Policy

Interaction summary

SHALL support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLDocumentReference

Core FHIR Resource
DocumentReference

Reference Policy

Interaction summary

SHOULD support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLFamilyMemberHistory

Core FHIR Resource
FamilyMemberHistory

Reference Policy

Interaction summary

SHOULD support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLMedicationAdministration

Core FHIR Resource
MedicationAdministration

Reference Policy

Interaction summary

SHOULD support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLMedicationDispense

Core FHIR Resource
MedicationDispense

Reference Policy

Interaction summary

SHOULD support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

Resource Conformance: SHALLMedicationStatement

Core FHIR Resource
MedicationStatement

Reference Policy

Interaction summary

SHOULD support search-type.

Search Parameters

Conformance	Parameter	Type
SHALL	_id	`reference`
SHALL	patient	`reference`
SHALL	encounter	`reference`
SHALL	code	`token`

Combined Search Parameters

Conformance	Parameters	Types
	_id+patient+encounter+code	`reference`+`reference`+`reference`+`token`

IG © 2020+ HL7 International / Public Health. Package hl7.fhir.uv.saner#1.0.1 based on FHIR 4.0.1. Generated 2024-01-25
Links: Table of Contents | QA Report | Version History | | Propose a change

CapabilityStatement: Data Source.

Data Source.

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALLPatient

Resource Conformance: SHALLEncounter

Resource Conformance: SHALLAllergyIntolerance

Resource Conformance: SHALLCondition

Resource Conformance: SHALLDiagnosticReport

Resource Conformance: SHALLMedicationRequest

Resource Conformance: SHALLObservation

Resource Conformance: SHALLProcedure

Resource Conformance: SHALLServiceRequest

Resource Conformance: SHALLDocumentReference

Resource Conformance: SHALLFamilyMemberHistory

Resource Conformance: SHALLMedicationAdministration

Resource Conformance: SHALLMedicationDispense

Resource Conformance: SHALLMedicationStatement

Mode: `server`