Conformance-daf-query-responder

DAF Query Responder

(Requirements Definition)

Published: 2014-11-19 (draft)

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

This profile defines the expected capabilities of the DAF Query Responder actor when conforming to the ONC's Data Access Framework FHIR implementation guide. This role is responsible for responding to query requests from DAF Query Requestor actor. The DAF Query Responder MUST process the query requests and provide valid or error responses which contain one or more FHIR resources conforming to profiles outlined in DAF implementation guide.

General

FHIR Version:	0.4.0
Supported formats:	JSON and XML

REST behavior

The DAF Query Responder MUST support all the resource profiles outlined by the DAF implementation guide. The DAF Query Responder MUST respond to DAF queries from DAF Query Requestor actor. In addition the DAF Query Responder MUST implement all the vocabularies and value set constraints defined by the individual resource profiles. The DAF Query Responder MUST implement REST behavior according to the FHIR specification and provide valid or error responses to query requests.

Security:

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

RESTful Operations Summary

Resource Name	Search	Read	Read Version	Instance History
DAFPatient	SHALL	SHALL	SHOULD	SHOULD
DAFAllergyIntolerance	SHALL	SHALL	SHOULD	SHOULD
DAFDiagnosticOrder	SHALL	SHALL	SHOULD	SHOULD
DAFDiagnosticReport	SHALL	SHALL	SHOULD	SHOULD
DAFEncounter	SHALL	SHALL	SHOULD	SHOULD
DAFFamilyHistory	SHALL	SHALL	SHOULD	SHOULD
DAFImmunization	SHALL	SHALL	SHOULD	SHOULD
DAFResults	SHALL	SHALL	SHOULD	SHOULD
DAFMedication	SHALL	SHALL	SHOULD	SHOULD
DAFMedicationStatement	SHALL	SHALL	SHOULD	SHOULD
DAFMedicationAdministration	SHALL	SHALL	SHOULD	SHOULD
DAFCondition	SHALL	SHALL	SHOULD	SHOULD
DAFProcedure	SHALL	SHALL	SHOULD	SHOULD
DAFSmokingStatus	SHALL	SHALL	SHOULD	SHOULD
DAFVitalSigns	SHALL	SHALL	SHOULD	SHOULD
DAFList	SHALL	SHOULD	SHOULD

Search Operations Summary

Resource Name	Search Parameters Supported
DAFPatient	name - Search based on given name or family name or text name (string) family - Search based on family name (string) given - Search based on given name (string) identifier - Search based on patient identifier (token) language - Search based on preferred language (token) telecom - Search based on telecom (string) gender - Search based on gender (token) birthdate - Search based on birthDate (date) city - Search based on City (string) postalCode - Search based on postal code (string) state - Search based on state (string) mothersMaidenName - Search based on Patient mother's Maiden Name (string) age - Search based on Patient's age (number) race - Search based on patient's race (token) ethnicity - Search based on patient's ethnicity (token)
DAFAllergyIntolerance	identifier - Search allergy by id subject - Search allergies for a patient category - Search based on category status - Search based on allergy status substance - Search based on allergy substance manifestation - Search based on allergy reaction severity - Search based on allergy severity duration - Search based on how long the allergy event lasted onset - Search based on when allergies manifested
DAFDiagnosticOrder	identifier - Search for DiagnosticOrder by id patient - Search for DiagnosticOrders for a patient orderer - Search based on ordering provider code - Search based on type of the test ordered encounter - Search based on encounter resulting in the order item-date - Search based on order date
DAFDiagnosticReport	identifier - Search for DiagnosticReport by id patient - Search for DiagnosticReport for a patient name - Search based on name of the test date - Search based on DiagnosticReport date service - Search based on DiagnosticReport category
DAFEncounter	identifier - Search for Encounter by id patient - Search for Encounter for a patient location - Search based on Encounter location type - Search based on type of the Encounter date - Search based on encounter start and end date
DAFFamilyHistory	identifier - Search for FamilyHistory by id patient - Search for FamilyHistory for a patient relationship - Search based on FamilyHistory Relationship type familyhistorycondition - Search based on the clinical condition of the related person
DAFImmunization	identifier - Search for Immunization by id patient - Search for Immunization for a patient date - Search based on Immunization date vaccine-type - Search based on type of the vaccine refused - Search based on whether immunization was refused reaction - Search based on type of immunization reaction lot-number - Search based on vaccine lot number requester - Search based on ordering provider
DAFResults	identifier - Search for lab test by id patient - Search for lab test for a patient name - Search based on lab test Name value-concept - Search for a lab test with a specific value which is a Code value-quantity - Search for a lab test with a value which is a quantity name-value[x] - Search for a lab test with a test name and value
DAFMedication	identifier - Search for MedicationStatement by id code - Search by drug code name - Search by drug name form - Search by drug form ingredient - Search by drug ingredient
DAFMedicationStatement	identifier - Search by id patient - Search for medications for a patient when-given - Search for medications by date of administration
DAFMedicationAdministration	identifier - Search by id patient - Search for medications for a patient effectivetime - Search for medications by date of administration encounter - Search for medications by encounter
DAFCondition	identifier - Search for Condition by id code - Search by Condition code category - Search by category of condition date-Asserted - Search by date condition was asserted encounter - Search by encounter onset - Search by onset Age of the condition patient - Search for conditions for a patient severity - Search for conditions by severity
DAFProcedure	identifier - Search for Procedure by id type - Search by Procedure type date - Search by date when procedure was performed patient - Search for conditions for a patient
DAFSmokingStatus	identifier - Search for SmokingStatus observation by id date - Search by period that applies to the smoking status value-concept - Search by a specific value which is a Code patient - Search for conditions for a patient
DAFVitalSigns	identifier - Search for VitalSigns by id date - Search by period that applies to the smoking status value-quantity - Search for Vital Signs with a value which is a quantity name-value[x] - Search for a Vital Signs with a name and value patient - Search for Vital Signs for a patient