Tutorials
Use Cases
Interface
Resources
- AllergyIntolerance
- AuditEvent
- Binary
- CarePlan
- Claim
- Condition
- Coverage
- Device
- DiagnosticOrder
- DiagnosticReport
- DocumentManifest
- DocumentReference
- Encounter
- FamilyMemberHistory
- Goal
- Group
- Immunization
- List
- Location
- MedicationAdministration
- MedicationDispense
- MedicationOrder
- MedicationStatement
- Observation
- OperationDefinition
- Organization
- Patient
- Person
- Practitioner
- Procedure
- ProcedureRequest
- Provenance
- Questionnaire
- QuestionnaireResponse
- ReferralRequest
- RelatedPerson
- Specimen
- Subscription
- ValueSet
Operations
- add
- classify
- code-terms
- compose-coding-system
- compose-demographic-identifier-system
- compose-identifier-system
- docref
- everything
- getPage
- get-page
- group-bulk-export
- patient-bulk-export
- remove
- remove-wrong-code-terms
- validate
- validate-coding-system
- validate-identifier-system
Examples & Testing
Endpoints
A Document Reference represents some form of document available to the information system, such as a CDA or FHIR document. The reference can point to another external system or to a binary resource.
Sample Query
Find document references for a specific patient:
https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir/DocumentReference?patient=f4968df0-3121-e611-8128-0a69c1b3225b
Overview
See the FHIR documentation for more information about Document Reference resources.
Mapped Concepts in HIEBus
- DocumentEntry
Supported Interactions
Document Reference resources support the following interactions.
Search Parameters
When searching for Document Reference resources, the following search parameters are supported.
| Name | Type | Prefixes
Modifiers |
Can be Chained? | Description |
|---|---|---|---|---|
| _id | Token | See the HL7 FHIR documentation. | ||
| class | Token | :missing | See the HL7 FHIR documentation. | |
| created | Date | gt ge lt le | See the HL7 FHIR documentation. | |
| event | Token | :missing | See the HL7 FHIR documentation. | |
| format | Token | :missing | See the HL7 FHIR documentation. | |
| identifier | Token | :missing | See the HL7 FHIR documentation. | |
| patient | Reference | :missing | yes | See the HL7 FHIR documentation. |
| securitylabel | Token | :missing | See the HL7 FHIR documentation. | |
| setting | Token | :missing | See the HL7 FHIR documentation. | |
| subject | Reference | :missing | yes | See the HL7 FHIR documentation. |
| type | Token | :missing | See the HL7 FHIR documentation. |
Sortable Parameters
When searching Document Reference resources, it is possible to sort the returned values by the following search parameters.
Only one sort parameter may be specified.
Supported Includes
When searching Document Reference resources, it is possible to include the resources referenced by the following field names.
- Patient
- Subject
Have questions about the HIEBus FHIR interface? Contact us at fhir@careevolution.com.
© 2023 CareEvolution, LLC
