DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Conformance-daf-query-requestor

This is the narrative for the resource. See also the XML or JSON format.

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 implementation guide.

General

FHIR Version: 0.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 use 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
DAFFamilyHistory SHOULD SHOULD SHOULD SHOULD
DAFImmunization SHOULD SHOULD SHOULD SHOULD
DAFLabResults 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:

DAF Requestors MAY use the following search contexts defined within the FHIRspecification.

  • 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 also use Composite Search Parameters as defined in the FHIR specification.

Resource Name Search and Include Parameters
DAFPatient
DAFAllergyIntolerance
  • identifier - Search AllergyIntolerances by identifiers(token)
  • patient - Search allergies for a patient(reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • 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)
  • duration - Search based on how long the allergy event lasted(quantity)
  • onset - Search based on when allergies manifested(date)
  • Include parameter - AllergyIntolerance.patient
DAFDiagnosticOrder
  • identifier - Search for DiagnosticOrder by identifiers (token)
  • patient - Search for DiagnosticOrders for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • orderer - Search based on ordering provider (reference)
  • Chained parameter - orderer.identifier
  • Chained parameter - orderer.given
  • Chained parameter - orderer.family
  • code - Search based on type of the test ordered (token)
  • encounter - Search based on encounter resulting in the order (reference)
  • Chained parameter - encounter.identifier
  • Chained parameter - encounter.type
  • item-date - Search based on order date (date)
  • Include parameter - DiagnosticOrder.subject
  • Include parameter - DiagnosticOrder.orderer
  • Include parameter - DiagnosticOrder.encounter
DAFDiagnosticReport
  • identifier - Search for DiagnosticReport by identifiers (token)
  • patient - Search for DiagnosticReport for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • name - Search based on name of the test (token)
  • date - Search based on DiagnosticReport date (date)
  • encounter - Search based on encounter resulting in the diagnostic report (reference)
  • Chained parameter - encounter.identifier
  • Chained parameter - encounter.type
  • performer - Search based on diagnostic report performer (reference)
  • Chained parameter - performer.identifier
  • Chained parameter - performer.name
  • result - Search based on results included in the diagnostic report (reference)
  • Chained parameter - result.type
  • Include parameter - DiagnosticReport.subject
  • Include parameter - DiagnosticReport.performer
  • Include parameter - DiagnosticReport.encounter
  • Include parameter - DiagnosticReport.result
DAFEncounter
  • identifier - Search for Encounter by identifiers (token)
  • patient - Search for Encounter for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • location - Search based on Encounter location (reference)
  • Chained parameter - location.identifier
  • Chained parameter - location.name
  • Chained parameter - location.address
  • 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
DAFFamilyHistory
  • identifier - Search for FamilyHistory by identifiers (token)
  • patient - Search for FamilyHistory for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • relationship - Search based on FamilyHistory Relationship type (token)
  • familyhistorycondition - Search based on the clinical condition of the related person (token)
  • Include parameter - FamilyHistory.patient
DAFImmunization
  • identifier - Search for Immunization by identifiers (token)
  • patient - Search for Immunization for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • date - Search based on Immunization date (date)
  • vaccine-type - Search based on type of the vaccine (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
  • Chained parameter - requester.name
  • Include parameter - Immunization.patient
  • Include parameter - Immunization.performer
  • Include parameter - Immunization.requester
  • Include parameter - Immunization.manufacturer
  • Include parameter - Immunization.reaction.detail
DAFResults
  • identifier - Search for lab test by identifiers (token)
  • patient - Search for lab test for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • code - Search based on lab test code (token)
  • value-concept - Search for a lab test with a specific value which is a code (token)
  • value-quantity - Search for a lab test with a value which is a quantity (quantity)
  • code-value[x] - Search for a lab test with a test name and value (composite)
  • date - Search based on lab test obtained date (date)
  • encounter - Search based on encounter resulting in the lab result (reference)
  • Chained parameter - encounter.identifier
  • Chained parameter - encounter.type
  • Include parameter - Observation.subject
  • Include parameter - Observation.encounter
DAFMedication
DAFMedicationStatement
  • identifier - Search by identifiers (token)
  • patient - Search for medications for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • effectivedate - Search for medications by date of administration (date)
  • medication - Search by medication (reference)
  • Chained parameter - medication.code
  • Chained parameter - medication.name
  • Include parameter - MedicationStatement.patient
  • Include parameter - MedicationStatement.medication
DAFMedicationAdministration
  • identifier - Search by identifiers (token)
  • patient - Search for medications for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • effectivetime - Search for medications by date of administration (date)
  • encounter - Search for medications by encounter (reference)
  • Chained parameter - encounter.identifier
  • Chained parameter - encounter.type
  • practitioner - Search based on practitioner (reference)
  • Chained parameter - practitioner.identifier
  • Chained parameter - practitioner.name
  • prescription - Search based on prescription (reference)
  • Chained parameter - prescription.identifier
  • Chained parameter - prescription.datewritten
  • Include parameter - MedicationAdministration.patient
  • Include parameter - MedicationAdministration.practitioner
  • Include parameter - MedicationAdministration.encounter
  • Include parameter - MedicationAdministration.prescription
DAFCondition
  • identifier - Search for Condition by identifiers (token)
  • code - Search by Condition code (token)
  • date-Asserted - Search by date condition was asserted (date)
  • encounter - Search by encounter (reference)
  • Chained parameter - encounter.identifier
  • Chained parameter - encounter.type
  • onset - Search by onset Age of the condition (date)
  • patient - Search for conditions for a patient (reference)
  • Chained parameter - patient.identifier
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • severity - Search for conditions by severity (token)
  • Include parameter - Condition.patient
  • Include parameter - Condition.encounter
  • Include parameter - Condition.asserter
DAFProcedure
  • identifier - Search for Procedure by identifiers (token)
  • type - 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
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • encounter - Search by encounter (reference)
  • Chained parameter - encounter.identifier
  • Chained parameter - encounter.type
  • Include parameter - Procedure.patient
  • Include parameter - Procedure.encounter
  • Include parameter - Procedure.performer
DAFSmokingStatus
  • 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
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • Include parameter - Observation.subject
  • Include parameter - Observation.encounter
DAFVitalSigns
  • 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
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • Include parameter - Observation.subject
  • Include parameter - Observation.encounter
DAFList
  • 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
  • Chained parameter - patient.name
  • Chained parameter - patient.given
  • Chained parameter - patient.family
  • Include parameter - List.subject
  • Include parameter - List.item


Security:

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

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.