Conformance-daf-query-responder

DAF Responder

(Requirements Definition)

Published: 2015-04-02

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

This profile defines the expected capabilities of the DAF Responder actor when conforming to the DAF FHIR IG. The profile includes the complete list of actual profiles, RESTful operations, search parameters supported by DAF Responders. DAF Requestors have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

General

FHIR Version:	DSTU2
Supported formats:	json and xml

REST behavior

The DAF Responder SHALL support the DAF-Patient resource profile. In addition to the DAFPatient, the DAF Responder SHALL support at least one additional resource profile from the list of DAF profiles. The DAF Responder SHALL implement REST behavior according to the FHIR specification. The DAF Responder SHALL support both json and xml resource formats for all DAF interactions. The DAF Responder SHALL identify the DAF profile(s) supported as part of the FHIR BaseResource.Meta.profile attribute for each instance.

Security:

DAF Responders SHALL meet the security requirements documented in the DAF FHIR IG.

RESTful Operations Summary

Resource(Profile Name)	Search	Read	Read Version	Instance History
DAF-Patient	SHALL	SHALL	SHOULD	SHOULD
DAF-AllergyIntolerance	SHALL	SHALL	SHOULD	SHOULD
DAF-DiagnosticOrder	SHALL	SHALL	SHOULD	SHOULD
DAF-DiagnosticReport	SHALL	SHALL	SHOULD	SHOULD
DAF-Encounter	SHALL	SHALL	SHOULD	SHOULD
DAF-FamilyMemberHistory	SHALL	SHALL	SHOULD	SHOULD
DAF-Immunization	SHALL	SHALL	SHOULD	SHOULD
DAF-Results	SHALL	SHALL	SHOULD	SHOULD
DAF-Medication	SHALL	SHALL	SHOULD	SHOULD
DAF-MedicationStatement	SHALL	SHALL	SHOULD	SHOULD
DAF-MedicationAdministration	SHALL	SHALL	SHOULD	SHOULD
DAF-MedicationOrder	SHALL	SHALL	SHOULD	SHOULD
DAF-MedicationDispense	SHALL	SHALL	SHOULD	SHOULD
DAF-Condition	SHALL	SHALL	SHOULD	SHOULD
DAF-Procedure	SHALL	SHALL	SHOULD	SHOULD
DAF-SmokingStatus	SHALL	SHALL	SHOULD	SHOULD
DAF-VitalSigns	SHALL	SHALL	SHOULD	SHOULD
DAF List	SHALL	SHALL	SHOULD	SHOULD

Supported profiles

DAF Responders SHALL support the DAFPatient profile. In addition to the DAFPatient profile, DAF Responders SHALL support at least one more profile (for e.g DAFCondition, DAFMedicationAdministration, DAFResults) from the DAF profiles listed in the DAF implementation guide.

Search Operations Summary

DAF Responders SHALL support the following common parameters as part of queries related to DAF profiles:

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

DAF Responders SHALL support the following search contexts defined within the FHIRspecification.

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

DAF Responders SHALL support Modifiers as applicable to the data types of the search parameters. DAF Responders SHALL also support Composite Search Parameters as defined in the FHIR specification.

Resource Name	Search and Include Parameters
DAF-Patient	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 ( token) gender - Search based on gender ( token) birthdate - Search based on birthDate ( date) address-city - Search based on City ( string) address-postalCode - Search based on postal code ( string) address-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) $everything - Return the entire patient record for a single patient.
DAF-AllergyIntolerance	identifier - Search AllergyIntolerances by identifiers( token) patient - Search allergies for a patient( reference) Chained parameter - patient.identifier category - Search based on category( token) status - Search based on allergy status( token) substance - Search based on allergy substance( token) manifestation - Search based on allergy reaction( token) severity - Search based on allergy severity( token) onset - Search based on when allergies manifested( date) Include parameter - AllergyIntolerance.patient
DAF-DiagnosticOrder	identifier - Search for DiagnosticOrder by identifiers ( token) patient - Search for DiagnosticOrders for a patient ( reference) Chained parameter - patient.identifier orderer - Search based on ordering provider ( reference) Chained parameter - orderer.identifier code - Search based on type of the test ordered ( token) encounter - Search based on encounter resulting in the order ( reference) Chained parameter - encounter.identifier item-date - Search based on order date ( date) Include parameter - DiagnosticOrder.subject Include parameter - DiagnosticOrder.orderer Include parameter - DiagnosticOrder.encounter
DAF-DiagnosticReport	identifier - Search for DiagnosticReport by identifiers ( token) patient - Search for DiagnosticReport for a patient ( reference) Chained parameter - patient.identifier date - Search based on DiagnosticReport date ( date) encounter - Search based on encounter resulting in the diagnostic report ( reference) Chained parameter - encounter.identifier performer - Search based on diagnostic report performer ( reference) Chained parameter - performer.identifier result - Search based on results included in the diagnostic report ( reference) Chained parameter - result.code Include parameter - DiagnosticReport.subject Include parameter - DiagnosticReport.performer Include parameter - DiagnosticReport.encounter Include parameter - DiagnosticReport.result
DAF-Encounter	identifier - Search for Encounter by identifiers ( token) patient - Search for Encounter for a patient ( reference) Chained parameter - patient.identifier location - Search based on Encounter location ( reference) Chained parameter - location.identifier type - Search based on type of the Encounter ( token) date - Search based on encounter start and end date ( date) location-period - Search based on time period during which the patient was at the location ( date) Include parameter - Encounter.patient Include parameter - Encounter.location $everything - Return all the data recorded as part of the encounter.
DAF-FamilyMemberHistory	identifier - Search for FamilyMemberHistory by identifiers ( token) patient - Search for FamilyMemberHistory for a patient ( reference) Chained parameter - patient.identifier relationship - Search based on FamilyMemberHistory Relationship type ( token) code - Search based on the clinical condition of the related person ( token) Include parameter - FamilyMemberHistory.patient
DAF-Immunization	identifier - Search for Immunization by identifiers ( token) patient - Search for Immunization for a patient ( reference) Chained parameter - patient.identifier date - Search based on Immunization date ( date) vaccine-code - Search based on vaccine product administered ( token) notgiven - Search based on whether immunization was notgiven ( token) lot-number - Search based on vaccine lot number ( string) requester - Search based on ordering provider ( reference) Chained parameter - requester.identifier Include parameter - Immunization.patient Include parameter - Immunization.performer Include parameter - Immunization.requester Include parameter - Immunization.manufacturer Include parameter - Immunization.reaction.detail
DAF-Results	identifier - Search for test by identifiers ( token) patient - Search for test for a patient ( reference) Chained parameter - patient.identifier code - Search based on test code ( token) value-concept - Search for a test with a specific value which is a code ( token) value-quantity - Search for a test with a value which is a quantity ( quantity) code-value[x] - Search for a test with a test name and value ( composite) date - Search based on test obtained date ( date) encounter - Search based on encounter resulting in the result ( reference) Chained parameter - encounter.identifier Include parameter - Observation.subject Include parameter - Observation.encounter Include parameter - Observation.related Reverse Include parameter - Observation.component
DAF-Medication	code - Search by drug code ( token) form - Search by drug form ( token) ingredient - Search by drug ingredient ( reference) Include parameter - Medication.manufacturer
DAF-MedicationStatement	identifier - Search by identifiers ( token) patient - Search for medications for a patient ( reference) Chained parameter - patient.identifier effectivedate - Search for medications by date of administration ( date) medication - Search by medication ( reference) Chained parameter - medication.code Include parameter - MedicationStatement.patient Include parameter - MedicationStatement.medication
DAF-MedicationAdministration	identifier - Search by identifiers ( token) patient - Search for medications for a patient ( reference) Chained parameter - patient.identifier effectivetime - Search for medications by date of administration ( date) encounter - Search for medications by encounter ( reference) Chained parameter - encounter.identifier practitioner - Search based on practitioner ( reference) Chained parameter - practitioner.identifier prescription - Search based on prescription ( reference) Chained parameter - prescription.identifier Include parameter - MedicationAdministration.patient Include parameter - MedicationAdministration.practitioner Include parameter - MedicationAdministration.encounter Include parameter - MedicationAdministration.prescription
DAF-MedicationDispense	identifier - Search by identifiers ( token) patient - Search for medications for a patient ( reference) Chained parameter - patient.identifier code - Search for medications by based on code ( token) medication - Search for medications dispensed by medication ( reference) Include parameter - MedicationDispense.patient Include parameter - MedicationDispense.medicationReference
DAF-MedicationOrder	identifier - Search by identifiers ( token) patient - Search for medication orders for a patient ( reference) Chained parameter - patient.identifier code - Search for medication orders by based on code ( token) medication - Search for medication orders by medication ( reference) Include parameter - MedicationOrder.patient Include parameter - MedicationOrder.medicationReference Include parameter - MedicationOrder.encounter Include parameter - MedicationOrder.prescriber
DAF-Condition	identifier - Search for Condition by identifiers ( token) code - Search by Condition code ( token) encounter - Search by encounter ( reference) Chained parameter - encounter.identifier onset - Search by onset Age of the condition ( date) patient - Search for conditions for a patient ( reference) Chained parameter - patient.identifier severity - Search for conditions by severity ( token) Include parameter - Condition.patient Include parameter - Condition.encounter Include parameter - Condition.asserter
DAF-Procedure	identifier - Search for Procedure by identifiers ( token) code - Search by Procedure type ( token) date - Search by date when procedure was performed ( date) patient - Search for conditions for a patient ( reference) Chained parameter - patient.identifier encounter - Search by encounter ( reference) Chained parameter - encounter.identifier Include parameter - Procedure.patient Include parameter - Procedure.encounter Include parameter - Procedure.performer
DAF-SmokingStatus	identifier - Search for SmokingStatus observation by identifiers ( token) date - Search by period that applies to the smoking status ( date) value-concept - Search by a specific value which is a Code ( token) patient - Search for conditions for a patient ( reference) Chained parameter - patient.identifier Include parameter - Observation.subject Include parameter - Observation.encounter
DAF-VitalSigns	identifier - Search for Vital Signs by identifiers ( token) date - Search by measurement date ( date) value-quantity - Search for Vital Signs with a value which is a quantity ( quantity) code - Search based on Vital Signs code ( token) code-value[x] - Search for a Vital Signs with a code and value ( token) patient - Search for Vital Signs for a patient ( reference) Chained parameter - patient.identifier Include parameter - Observation.subject Include parameter - Observation.encounter
DAF List	identifier - Search for List by identifiers ( token) code - Search by type of list ( token) date - Search by list preparation date ( date) empty-reason - Search by empty reason code ( token) patient - Search for list by patient ( reference) Chained parameter - patient.identifier Include parameter - List.subject Include parameter - List.item