DocumentReference_GET

GET {{baseUrl}}/DocumentReference?patient=<string>&encounter=<string>&authenticator=<string>&author=<string>&custodian=<string>&related-ref=<string>&relatesto=<string>&subject=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&identifier=<string>&type=<string>&class=<string>&created=<date>&description=<string>&event=<string>&facility=<string>&format=<string>&indexed=<date>&language=<string>&location=<string>&period=<date>&related-id=<string>&relation=<string>&relationship=<string>&securitylabel=<string>&setting=<string>&status=<string>&_format=<string>

Request Params

• ReferralRequest: Who the referral is about

• DocumentManifest: The subject of the set of documents

• Goal: Who this goal is intended for

• Consent: Who the consent applies to

• DocumentReference: Who/what is the subject of the document

• ImagingManifest: Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents)

• RiskAssessment: Who/what does assessment apply to?

• CareTeam: Who care team is for

• ImagingStudy: Who the study is about

• FamilyMemberHistory: The identity of a subject to list family member history items for

• Encounter: The patient ro group present at the encounter

• DeviceUseStatement: Search by subject - a patient

• DeviceRequest: Individual the service is ordered for

• AllergyIntolerance: Who the sensitivity is for

• CarePlan: Who care plan is for

• EpisodeOfCare: The patient who is the focus of this episode of care

• Procedure: Search by subject - a patient

• List: If all resources have the same subject

• Immunization: The patient for the vaccination record

• VisionPrescription: The identity of a patient to list dispenses for

• ProcedureRequest: Search by subject - a patient

• Flag: The identity of a subject to list flags for

• Observation: The subject that the observation is about (if patient)

• DiagnosticReport: The subject of the report if a patient

• NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement

• Condition: Who has the condition?

• Composition: Who and/or what the composition is about

• DetectedIssue: Associated patient

• SupplyDelivery: Patient for whom the item is supplied

• ClinicalImpression: Patient or group assessed | | encounter | string | | Multiple Resources:

• DocumentReference: Context of the document content

• RiskAssessment: Where was assessment performed?

• DeviceRequest: Encounter or Episode during which request was created

• Procedure: Search by encounter

• List: Context in which list created

• VisionPrescription: Return prescriptions with this encounter identifier

• ProcedureRequest: An encounter in which this request is made

• Flag: Alert relevant during encounter

• Observation: Encounter related to the observation

• DiagnosticReport: The Encounter when the order was made

• NutritionOrder: Return nutrition orders with this encounter identifier

• Composition: Context of the Composition | | authenticator | string | | Who/what authenticated the document | | author | string | | Who and/or what authored the document | | custodian | string | | Organization which maintains the document | | related-ref | string | | Related Resource | | relatesto | string | | Target of the relationship | | subject | string | | Who/what is the subject of the document | | _id | string | | Logical id of this artifact | | _lastUpdated | string | | When the resource version last changed | | _profile | string | | Profiles this resource claims to conform to | | _security | string | | Security Labels applied to this resource | | _tag | string | | Tags applied to this resource | | identifier | string | | Multiple Resources:

• DocumentManifest: Unique Identifier for the set of documents

• Goal: External Ids for this goal

• Consent: Identifier for this record (external references)

• DocumentReference: Master Version Specific Identifier

• SupplyRequest: Unique identifier

• RiskAssessment: Unique identifier for the assessment

• CareTeam: External Ids for this team

• ImagingStudy: Other identifiers for the Study

• FamilyMemberHistory: A search by a record identifier

• Encounter: Identifier(s) by which this encounter is known

• DeviceRequest: Business identifier for request/order

• AllergyIntolerance: External ids for this item

• CarePlan: External Ids for this plan

• EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare

• Procedure: A unique identifier for a procedure

• List: Business identifier

• Immunization: Business identifier

• VisionPrescription: Return prescriptions with this external identifier

• ProcedureRequest: Identifiers assigned to this order

• Observation: The unique id for a particular observation

• DiagnosticReport: An identifier for the report

• NutritionOrder: Return nutrition orders with this external identifier

• Condition: A unique identifier of the condition record

• Composition: Logical identifier of composition (version-independent)

• DetectedIssue: Unique id for the detected issue

• SupplyDelivery: External identifier | | type | string | | Multiple Resources:

• ReferralRequest: The type of the referral

• DocumentManifest: Kind of document set

• DocumentReference: Kind of document (LOINC if possible)

• Encounter: Specific type of encounter

• AllergyIntolerance: allergy | intolerance - Underlying mechanism (if known)

• EpisodeOfCare: Type/class - e.g. specialist referral, disease management

• Composition: Kind of composition (LOINC if possible) | | class | string | | Categorization of document | | created | string | | Document creation time | | description | string | | Human-readable description (title) | | event | string | | Main clinical acts documented | | facility | string | | Kind of facility where patient was seen | | format | string | | Format/content rules for the document | | indexed | string | | When this document reference was created | | language | string | | Human language of the content (BCP-47) | | location | string | | Uri where the data can be found | | period | string | | Time of service that is being documented | | related-id | string | | Identifier of related objects or events | | relation | string | | replaces | transforms | signs | appends | | relationship | string | | Combination of relation and relatesTo | | securitylabel | string | | Document security-tags | | setting | string | | Additional details about where the content was created (e.g. clinical specialty) | | status | string | | current | superseded | entered-in-error | | _format | string | | |

RESPONSES

status: OK

[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"contained":[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","name":[{"family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"]}],"practitionerRole":[{"organization":{"display":"\u003cstring\u003e"},"role":{"text":"\u003cstring\u003e"},"specialty":[{"text":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}]}],"masterIdentifier":{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"class":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"author":[{"reference":"\u003cstring\u003e"}],"custodian":{"reference":"\u003cstring\u003e"},"authenticator":{"reference":"\u003cstring\u003e"},"created":"\u003cstring\u003e","indexed":"\u003cstring\u003e","status":"\u003cstring\u003e","docStatus":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"relatesTo":[{"code":"\u003cstring\u003e","target":{"reference":"\u003cstring\u003e"}}],"description":"\u003cstring\u003e","securityLabel":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"content":[{"attachment":{"contentType":"\u003cstring\u003e","language":"\u003cstring\u003e","url":"\u003cstring\u003e","size":"\u003cnumber\u003e","hash":"\u003cstring\u003e"},"format":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"context":{"encounter":{"reference":"\u003cstring\u003e"},"event":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"period":{"start":"\u003cstring\u003e","end":"\u003cstring\u003e"},"facilityType":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"practiceSetting":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"sourcePatientInfo":{"reference":"\u003cstring\u003e"},"related":[{"identifier":{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},"ref":{"reference":"\u003cstring\u003e"}}]}},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"fhir_comments":["\u003cobject\u003e","\u003cobject\u003e"],"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"contained":[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","name":[{"family":["\u003cobject\u003e","\u003cobject\u003e"],"given":["\u003cobject\u003e","\u003cobject\u003e"]}],"practitionerRole":[{"organization":{"display":"\u003cstring\u003e"},"role":{"text":"\u003cstring\u003e"},"specialty":[{"text":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}]}],"masterIdentifier":{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},"identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"subject":{"reference":"\u003cstring\u003e"},"type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"class":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"author":[{"reference":"\u003cstring\u003e"}],"custodian":{"reference":"\u003cstring\u003e"},"authenticator":{"reference":"\u003cstring\u003e"},"created":"\u003cstring\u003e","indexed":"\u003cstring\u003e","status":"\u003cstring\u003e","docStatus":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"relatesTo":[{"code":"\u003cstring\u003e","target":{"reference":"\u003cstring\u003e"}}],"description":"\u003cstring\u003e","securityLabel":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"content":[{"attachment":{"contentType":"\u003cstring\u003e","language":"\u003cstring\u003e","url":"\u003cstring\u003e","size":"\u003cnumber\u003e","hash":"\u003cstring\u003e"},"format":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"context":{"encounter":{"reference":"\u003cstring\u003e"},"event":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"period":{"start":"\u003cstring\u003e","end":"\u003cstring\u003e"},"facilityType":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"practiceSetting":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"sourcePatientInfo":{"reference":"\u003cstring\u003e"},"related":[{"identifier":{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},"ref":{"reference":"\u003cstring\u003e"}}]}}]