DocumentReference

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents %28CDA%29, cliical notes, scanned paper, and non-patient specific documents like policy text.

Structure

Search Parameters

_haste-health-author (reference)

The author of the resource

Resource.meta.extension.where(url='https://haste.health/author').value

_type (token)

Derived from the R4B Definition

$this.type().name

_text (string)

Search on the narrative of the resource

_content (string)

Search on the entire content of the resource

_id (token)

Logical id of this artifact

Resource.id

_lastUpdated (date)

When the resource version last changed

Resource.meta.lastUpdated

_profile (uri)

Profiles this resource claims to conform to

Resource.meta.profile

_query (token)

A custom search profile that describes a specific defined query operation

_security (token)

Security Labels applied to this resource

Resource.meta.security

_source (uri)

Identifies where the resource comes from

Resource.meta.source

_tag (token)

Tags applied to this resource

Resource.meta.tag

identifier (token)

Multiple Resources: * %5BAllergyIntolerance%5D%28allergyintolerance.html%29: External ids for this item* %5BCarePlan%5D%28careplan.html%29: External Ids for this plan* %5BCareTeam%5D%28careteam.html%29: External Ids for this team* %5BComposition%5D%28composition.html%29: Version-independent identifier for the Composition* %5BCondition%5D%28condition.html%29: A unique identifier of the condition record* %5BConsent%5D%28consent.html%29: Identifier for this record %28external references%29* %5BDetectedIssue%5D%28detectedissue.html%29: Unique id for the detected issue* %5BDeviceRequest%5D%28devicerequest.html%29: Business identifier for request/order* %5BDiagnosticReport%5D%28diagnosticreport.html%29: An identifier for the report* %5BDocumentManifest%5D%28documentmanifest.html%29: Unique Identifier for the set of documents* %5BDocumentReference%5D%28documentreference.html%29: Master Version Specific Identifier* %5BEncounter%5D%28encounter.html%29: Identifier%28s%29 by which this encounter is known* %5BEpisodeOfCare%5D%28episodeofcare.html%29: Business Identifier%28s%29 relevant for this EpisodeOfCare* %5BFamilyMemberHistory%5D%28familymemberhistory.html%29: A search by a record identifier* %5BGoal%5D%28goal.html%29: External Ids for this goal* %5BImagingStudy%5D%28imagingstudy.html%29: Identifiers for the Study, such as DICOM Study Instance UID and Accession number* %5BImmunization%5D%28immunization.html%29: Business identifier* %5BList%5D%28list.html%29: Business identifier* %5BMedicationAdministration%5D%28medicationadministration.html%29: Return administrations with this external identifier* %5BMedicationDispense%5D%28medicationdispense.html%29: Returns dispenses with this external identifier* %5BMedicationRequest%5D%28medicationrequest.html%29: Return prescriptions with this external identifier* %5BMedicationStatement%5D%28medicationstatement.html%29: Return statements with this external identifier* %5BNutritionOrder%5D%28nutritionorder.html%29: Return nutrition orders with this external identifier* %5BObservation%5D%28observation.html%29: The unique id for a particular observation* %5BProcedure%5D%28procedure.html%29: A unique identifier for a procedure* %5BRiskAssessment%5D%28riskassessment.html%29: Unique identifier for the assessment* %5BServiceRequest%5D%28servicerequest.html%29: Identifiers assigned to this order* %5BSupplyDelivery%5D%28supplydelivery.html%29: External identifier* %5BSupplyRequest%5D%28supplyrequest.html%29: Business Identifier for SupplyRequest* %5BVisionPrescription%5D%28visionprescription.html%29: Return prescriptions with this external identifier

AllergyIntolerance.identifier / CarePlan.identifier / CareTeam.identifier / Composition.identifier / Condition.identifier / Consent.identifier / DetectedIssue.identifier / DeviceRequest.identifier / DiagnosticReport.identifier / DocumentManifest.masterIdentifier / DocumentManifest.identifier / DocumentReference.masterIdentifier / DocumentReference.identifier / Encounter.identifier / EpisodeOfCare.identifier / FamilyMemberHistory.identifier / Goal.identifier / ImagingStudy.identifier / Immunization.identifier / List.identifier / MedicationAdministration.identifier / MedicationDispense.identifier / MedicationRequest.identifier / MedicationStatement.identifier / NutritionOrder.identifier / Observation.identifier / Procedure.identifier / RiskAssessment.identifier / ServiceRequest.identifier / SupplyDelivery.identifier / SupplyRequest.identifier / VisionPrescription.identifier

patient (reference)

Multiple Resources: * %5BAllergyIntolerance%5D%28allergyintolerance.html%29: Who the sensitivity is for* %5BCarePlan%5D%28careplan.html%29: Who the care plan is for* %5BCareTeam%5D%28careteam.html%29: Who care team is for* %5BClinicalImpression%5D%28clinicalimpression.html%29: Patient or group assessed* %5BComposition%5D%28composition.html%29: Who and/or what the composition is about* %5BCondition%5D%28condition.html%29: Who has the condition?* %5BConsent%5D%28consent.html%29: Who the consent applies to* %5BDetectedIssue%5D%28detectedissue.html%29: Associated patient* %5BDeviceRequest%5D%28devicerequest.html%29: Individual the service is ordered for* %5BDeviceUseStatement%5D%28deviceusestatement.html%29: Search by subject - a patient* %5BDiagnosticReport%5D%28diagnosticreport.html%29: The subject of the report if a patient* %5BDocumentManifest%5D%28documentmanifest.html%29: The subject of the set of documents* %5BDocumentReference%5D%28documentreference.html%29: Who/what is the subject of the document* %5BEncounter%5D%28encounter.html%29: The patient or group present at the encounter* %5BEpisodeOfCare%5D%28episodeofcare.html%29: The patient who is the focus of this episode of care* %5BFamilyMemberHistory%5D%28familymemberhistory.html%29: The identity of a subject to list family member history items for* %5BFlag%5D%28flag.html%29: The identity of a subject to list flags for* %5BGoal%5D%28goal.html%29: Who this goal is intended for* %5BImagingStudy%5D%28imagingstudy.html%29: Who the study is about* %5BImmunization%5D%28immunization.html%29: The patient for the vaccination record* %5BList%5D%28list.html%29: If all resources have the same subject* %5BMedicationAdministration%5D%28medicationadministration.html%29: The identity of a patient to list administrations for* %5BMedicationDispense%5D%28medicationdispense.html%29: The identity of a patient to list dispenses for* %5BMedicationRequest%5D%28medicationrequest.html%29: Returns prescriptions for a specific patient* %5BMedicationStatement%5D%28medicationstatement.html%29: Returns statements for a specific patient.* %5BNutritionOrder%5D%28nutritionorder.html%29: The identity of the person who requires the diet, formula or nutritional supplement* %5BObservation%5D%28observation.html%29: The subject that the observation is about %28if patient%29* %5BProcedure%5D%28procedure.html%29: Search by subject - a patient* %5BRiskAssessment%5D%28riskassessment.html%29: Who/what does assessment apply to?* %5BServiceRequest%5D%28servicerequest.html%29: Search by subject - a patient* %5BSupplyDelivery%5D%28supplydelivery.html%29: Patient for whom the item is supplied* %5BVisionPrescription%5D%28visionprescription.html%29: The identity of a patient to list dispenses for

AllergyIntolerance.patient / CarePlan.subject.where(resolve() is Patient) / CareTeam.subject.where(resolve() is Patient) / ClinicalImpression.subject.where(resolve() is Patient) / Composition.subject.where(resolve() is Patient) / Condition.subject.where(resolve() is Patient) / Consent.patient / DetectedIssue.patient / DeviceRequest.subject.where(resolve() is Patient) / DeviceUseStatement.subject / DiagnosticReport.subject.where(resolve() is Patient) / DocumentManifest.subject.where(resolve() is Patient) / DocumentReference.subject.where(resolve() is Patient) / Encounter.subject.where(resolve() is Patient) / EpisodeOfCare.patient / FamilyMemberHistory.patient / Flag.subject.where(resolve() is Patient) / Goal.subject.where(resolve() is Patient) / ImagingStudy.subject.where(resolve() is Patient) / Immunization.patient / List.subject.where(resolve() is Patient) / MedicationAdministration.subject.where(resolve() is Patient) / MedicationDispense.subject.where(resolve() is Patient) / MedicationRequest.subject.where(resolve() is Patient) / MedicationStatement.subject.where(resolve() is Patient) / NutritionOrder.patient / Observation.subject.where(resolve() is Patient) / Procedure.subject.where(resolve() is Patient) / RiskAssessment.subject.where(resolve() is Patient) / ServiceRequest.subject.where(resolve() is Patient) / SupplyDelivery.patient / VisionPrescription.patient

type (token)

Multiple Resources: * %5BAllergyIntolerance%5D%28allergyintolerance.html%29: allergy / intolerance - Underlying mechanism %28if known%29* %5BComposition%5D%28composition.html%29: Kind of composition %28LOINC if possible%29* %5BDocumentManifest%5D%28documentmanifest.html%29: Kind of document set* %5BDocumentReference%5D%28documentreference.html%29: Kind of document %28LOINC if possible%29* %5BEncounter%5D%28encounter.html%29: Specific type of encounter* %5BEpisodeOfCare%5D%28episodeofcare.html%29: Type/class - e.g. specialist referral, disease management

AllergyIntolerance.type / Composition.type / DocumentManifest.type / DocumentReference.type / Encounter.type / EpisodeOfCare.type

encounter (reference)

Multiple Resources: * %5BComposition%5D%28composition.html%29: Context of the Composition* %5BDeviceRequest%5D%28devicerequest.html%29: Encounter during which request was created* %5BDiagnosticReport%5D%28diagnosticreport.html%29: The Encounter when the order was made* %5BDocumentReference%5D%28documentreference.html%29: Context of the document content* %5BFlag%5D%28flag.html%29: Alert relevant during encounter* %5BList%5D%28list.html%29: Context in which list created* %5BNutritionOrder%5D%28nutritionorder.html%29: Return nutrition orders with this encounter identifier* %5BObservation%5D%28observation.html%29: Encounter related to the observation* %5BProcedure%5D%28procedure.html%29: Encounter created as part of* %5BRiskAssessment%5D%28riskassessment.html%29: Where was assessment performed?* %5BServiceRequest%5D%28servicerequest.html%29: An encounter in which this request is made* %5BVisionPrescription%5D%28visionprescription.html%29: Return prescriptions with this encounter identifier

Composition.encounter / DeviceRequest.encounter / DiagnosticReport.encounter / DocumentReference.context.encounter / Flag.encounter / List.encounter / NutritionOrder.encounter / Observation.encounter / Procedure.encounter / RiskAssessment.encounter / ServiceRequest.encounter / VisionPrescription.encounter

authenticator (reference)

Who/what authenticated the document

DocumentReference.authenticator

author (reference)

Who and/or what authored the document

DocumentReference.author

category (token)

Categorization of document

DocumentReference.category

contenttype (token)

Mime type of the content, with charset etc.

DocumentReference.content.attachment.contentType

custodian (reference)

Organization which maintains the document

DocumentReference.custodian

date (date)

When this document reference was created

DocumentReference.date

description (string)

Human-readable description

DocumentReference.description

event (token)

Main clinical acts documented

DocumentReference.context.event

facility (token)

Kind of facility where patient was seen

DocumentReference.context.facilityType

format (token)

Format/content rules for the document

DocumentReference.content.format

language (token)

Human language of the content %28BCP-47%29

DocumentReference.content.attachment.language

location (uri)

Uri where the data can be found

DocumentReference.content.attachment.url

period (date)

Time of service that is being documented

DocumentReference.context.period

related (reference)

Related identifiers or resources

DocumentReference.context.related

relatesto (reference)

Target of the relationship

DocumentReference.relatesTo.target

relation (token)

replaces / transforms / signs / appends

DocumentReference.relatesTo.code

security-label (token)

Document security-tags

DocumentReference.securityLabel

setting (token)

Additional details about where the content was created %28e.g. clinical specialty%29

DocumentReference.context.practiceSetting

status (token)

current / superseded / entered-in-error

DocumentReference.status

subject (reference)

Who/what is the subject of the document

DocumentReference.subject

relationship (composite)

Combination of relation and relatesTo

DocumentReference.relatesTo