Conformance-daf-query-requestor

DAF Requestor

(Requirements Definition)

Published: 2015-04-02 (draft)

Published by: U.S. Office of the National Coordinator (ONC)

This profile defines the expected capabilities of the DAF Requestor actor when conforming to the DAF FHIR IG.

General

FHIR Version:	1.4.0 (DSTU2)
Supported formats:	JSON or XML

REST behavior

The DAF Requestor SHALL support accessing at least one FHIR resource using the appropriate DAF profile(s) for the resource being accessed. The DAF Requestor SHALL implement REST behavior according to the FHIR specification. The DAF Requestor SHALL support either json or xml resource formats for all DAF interactions.

RESTful Operations Summary

Resource(Profile Name)	Search	Read	Read Version	Instance History
DAFPatient	SHOULD	SHOULD	SHOULD	SHOULD
DAFAllergyIntolerance	SHOULD	SHOULD	SHOULD	SHOULD
DAFDiagnosticOrder	SHOULD	SHOULD	SHOULD	SHOULD
DAFDiagnosticReport	SHOULD	SHOULD	SHOULD	SHOULD
DAFEncounter	SHOULD	SHOULD	SHOULD	SHOULD
DAFFamilyMemberHistory	SHOULD	SHOULD	SHOULD	SHOULD
DAFImmunization	SHOULD	SHOULD	SHOULD	SHOULD
DAFResults	SHOULD	SHOULD	SHOULD	SHOULD
DAFMedication	SHOULD	SHOULD	SHOULD	SHOULD
DAFMedicationStatement	SHOULD	SHOULD	SHOULD	SHOULD
DAFMedicationAdministration	SHOULD	SHOULD	SHOULD	SHOULD
DAFCondition	SHOULD	SHOULD	SHOULD	SHOULD
DAFProcedure	SHOULD	SHOULD	SHOULD	SHOULD
DAFSmokingStatus	SHOULD	SHOULD	SHOULD	SHOULD
DAFVitalSigns	SHOULD	SHOULD	SHOULD	SHOULD
DAFList	SHOULD	SHOULD	SHOULD	SHOULD

Search Operations Summary

DAF Requestors MAY use the following common parameters as part of queries related to DAF profiles:

• _id
• _lastUpdated
• _profile
• _security
• _tag
• _text
• _count
• _summary
• _contained
• _containedType

DAF Requestors SHOULD use the following common parameters as part of queries related to DAF profiles to avoid repeated queries.

• _include

DAF Requestors MAY use the following search contexts defined within the FHIR specification.

• Search context by specifying a particular resource type
• Search context which specifies a compartment

DAF Requestors MAY use Modifiers as applicable to the data types of the search parameters to access data. DAF Requestors MAY use any search parameters that are appropriate for querying a particular FHIR resource, however they can only count on the search parameters that are identified as SHALL within the DAF Responder's conformance statement to be used in the execution of the search. For a complete list of search parameters that are available, please refer to DAF Responder's conformance statement and the search parameters supported by the base FHIR resources profiled by DAF.

Security:

Implementations must meet the security requirements documented in the DAF implementation guide.