eHealth Infrastructure - Local Development build (vlatest) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Ehealth Documentreference Search

search

OPERATION: DocumentReference search

This operation returns DocumentReference resources that match given input search criteria by forwarding the search as a query for document metadata on the national IHE XDS.b based document sharing infrastructure.

The operation implements the Document Responder actor of the ITI-67 Find Document References transaction of Integrating the Healthcare Enterprise (IHE) Mobile access to Health Documents (MHD) with XDS on FHIR option. The ITI-67 is described in IHE ITI Supplement MHD.

Input

The name and definition of search parameters given below are elaborated in the Find Document References ITI-67 specification section 3.67.4.1.2.1 Query Search Parameters.

In addition, there are two parameters related to the ability to perform break-the-glass querying (in Danish known as værdispring):

• consentOverride signifies, when set to true, that the search (query) for document metadata shall be performed with override of any withholding of information in accordance with patient’s consents possibly performed by the national document sharing service. The preferred method is to call this operation without consent override and to only call with consent override when necessary.
• reason is the user’s rationale for choosing to override consents and it is mandatory when parameter consentOverride is set to true. The value is logged in the eHealth Infrastructure.

Output

When available to the requesting user, DocumentReference resources corresponding to found XDS document metadata are returned. Also returned in the Bundle is an OperationOutcome capturing any errors and warnings possibly returned with the document sharing response, whether those reflect a Success or PartialSuccess.

In general, Coded values and identifiers in input must be stated using the url used in the eHealth Infrastructure. These are then automatically transformed to object identifier (OID) form for querying XDS. Similarly, OID in the XDS response is transformed automatically to url form in the output.

Note that the output Bundle.total might reflect a greater number than the number of entries actually returned. As there is no paging support for the query, this means that there are matching entries that are not returned. In this case, the client should split the search period into smaller ones until the total reflects the number of entries.

URL: GET [base]/DocumentReference?<query>

Parameters

Use	Name	Cardinality	Type	Binding	Documentation
IN	patient	0..1	Reference
IN	patient.identifier	0..1	token
IN	status	1..*	code	http://hl7.org/fhir/ValueSet/document-reference-status	current and/or superseded
IN	date	0..1	Period
IN	class	0..*	token	http://sundhedsdatastyrelsen.dk/terminologi/dk-ihe-classcode-vs
IN	type	0..*	token	http://sundhedsdatastyrelsen.dk/terminologi/dk-ihe-typecode-vs
IN	setting	0..*	token	http://sundhedsdatastyrelsen.dk/terminologi/dk-ihe-practicesettingcode-vs
IN	period	0..*	Period
IN	facility	0..*	token	http://sundhedsdatastyrelsen.dk/terminologi/dk-ihe-healthcarefacilitytypecode-vs
IN	event	0..*	token	http://sundhedsdatastyrelsen.dk/terminologi/dk-ihe-eventcodelists-vs
IN	format	0..*	token	http://sundhedsdatastyrelsen.dk/terminologi/dk-ihe-formatcode-vs
IN	consentOverride	0..1	token
IN	reason	0..1	String
OUT	return	1..1	Bundle