PACIO Advance Directive Interoperability Implementation Guide
1.0.0 - STU 1 United States of America flag

This page is part of the PACIO Advance Directive Information Implementation Guide (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Recommended Search Parameters

Bundle

Parameter Type Conf. Description Example
_id token SHOULD Search by FHIR resource ID GET [base]/Bundle?_id=[id]
composition reference SHOULD Search by reference to a composition GET [base]/Bundle?composition=[reference]
identifier token SHOULD Search by business identifier GET [base]/Bundle?identifier=[token]
timestamp date SHOULD Search by a date in time GET [base]/Bundle?timestamp=[date]
type token SHOULD Search by type code GET [base]/Bundle?type=[system]|[code]

 

Parameter Type Conf. Description Example
id token SHALL Search by FHIR resource id of a Consent GET [base]/Consent/[id]
_history/vid token SHOULD Search by historical version number GET [base]/Consent/[id]/_history/vid

 

ADI-DocumentReference (DocumentReference)

Parameter Type Conf. Description Example
id token SHALL Search by FHIR resource id GET [base]/DocumentReference/[id]
_history/vid token SHOULD Search by historical version GET [base]/DocumentReference/[id]/_history/vid
_id token SHALL Search by FHIR resource ID GET [base]/DocumentReference?_id=[id]
authenticator reference MAY Search by who/what authenticated the document GET [base]/DocumentReference?authenticator=[reference]
author string MAY Search by who and/or what authored the document GET [base]/DocumentReference?author=[reference]
category token SHOULD Search by categorization of document GET [base]/DocumentReference?category=[system]|[code]
contenttype token SHOULD Search by MIME type of the content, with charset etc. GET [base]/DocumentReference?contenttype=[system]|[code]
custodian reference SHALL Search by organization which maintains the document GET [base]/DocumentReference?custodian=[reference]
date date SHALL Search by when this document reference was created GET [base]/DocumentReference?date=[date]
description string MAY Search by human-readable description GET [base]/DocumentReference?description=[description]
encounter reference MAY Search by encounter reference GET [base]/DocumentReference?encounter=[reference]
event token MAY Search by main clinical acts documented GET [base]/DocumentReference?event=[system]|[code]
facility token MAY Search by kind of facility where patient was seen GET [base]/DocumentReference?facility=[system]|[code]
format token SHOULD Search by format code content rules for the document GET [base]/DocumentReference?format=[system]|[code]
identifier token SHALL Search by business identifier of the attachment binary GET [base]/DocumentReference?identifier=[system]|[code]
language token MAY Search by human language of the content (BCP-47) GET [base]/DocumentReference?language=[system]|[code]
location uri MAY Search by uri where the data can be found GET [base]/DocumentReference?location=[uri]
patient reference SHALL Search by who is the subject of the document GET [base]/DocumentReference?patient=[reference]
period date SHALL Search by time of service that is being documented GET [base]/DocumentReference?period=[period]
related reference MAY Search by related identifier or resource GET [base]/DocumentReference?related=[reference]
relatesto reference MAY Search by target of the relationship GET [base]/DocumentReference?relatesto=[reference]
relation token MAY Search by relation code (replaces | transforms | signs | appends) GET [base]/DocumentReference?relation=[system]|[code]
security-label token MAY Search by document security-tags GET [base]/DocumentReference?security-label=[system]|[code]
setting token MAY Search by additional details about where the content was created (e.g. clinical specialty) GET [base]/DocumentReference?setting=[system]|[code]
status token SHALL Search by document reference status code (current | superseded | entered-in-error) GET [base]/DocumentReference?status=[status]
subject reference MAY Search by who/what is the subject of the document GET [base]/DocumentReference?subject=[reference]
type token SHALL Search by kind of document GET [base]/DocumentReference?type=[system]|[code]

 

Patient

We strongly recommend using the $match operation in performing a system-to-system query to ensure that the right patient is selected. The Patient.search parameters below may be generally used for subsequent queries once the patient is selected. Search parameter requirements for Patient under this IG match those for US Core Patient search requirements