FHIR DocumentReference

FHIR DocumentReference

Choose operation

Search

get
/

Parameters

Patient
string

Search by Patient's Logical ID.

Patient.identifier
string

Social Security Number or a system value followed by Social Security Number, or a system value followed by Patient ID.

_id
string

Search by Document ID.

viewdocumenttypestemplate & text
string

Search by the document type name in all the document types.

viewdocumenttypestemplate & text:exact
string

Search by the exact name of the document type.

viewdocumenttypestemplate & text:contains
string

Search by the document types which contain the given document type name.

viewdocumenttypestemplate & DocumentTypeId
string

Search document type by document type Id.

_query
string

The search query parameter. Possible values: - `JournalGroupsProfile`: Search by journal selections (EPR Group Profiles). - `EprGroupProfileEprGroups`: Search by EPR groups. - `DocumentTypeDocumentTypeIds`: Search by document Type. - `BooleanFilters`: Search by document filters - boolean filters. - `ShowTechnicalDocumentStatus`: Search by document filters - technical document.

encounter.hospitalization
string

Search by Hospitalization.

Encounter.episodeofcare
string

Search by Episode of Care (contact IDs).

period.start={date}&period.end={date}
string

Search by event time.

sort
string

The sort parameter. Possible values: - `Status`: Sort by document status (NotCompleted, NotApproved, Approved). - `EventTime`: Sort by the time of the incident. - `IsSigned`: Sort by "signed" status (If the document is signed or not). - `CreatedBy`: Sort by the author of the document. - `LastModifiedBy`: Sort by the last modified person. - `ReferralId`: Sort by Referral IDs. This will be the reference ID of either an appointment (Contact) or admission to the hospital (Episode of Care/Hospitalization). - `DepartmentLongName`: Sort by Department name. - `Department`: Sort by Department ID.

_include
string

The _include parameter.

Responses:

resourceType
string

total
integer

link
array

link[].relation
string

link[].url
string

entry
array

entry[].fullUrl
string

entry[].resource
object

resourceType
string

id
string

contained
array

contained[].resourceType
string

contained[].id
string

contained[].extension
array

contained[].extension[].url
string

contained[].extension[].valueString
string

contained[].extension[].valueDateTime
string

contained[].identifier
array

contained[].identifier[].system
string

contained[].identifier[].value
string

contained[].code
object

coding
array

coding[].system
string

coding[].code
string

coding[].display
string

contained[].executionPeriod
object

end
string

extension
array

extension[].url
string

extension[].valueDateTime
string

extension[].valueString
string

status
string

docStatus
string

type
object

coding
array

coding[].system
string

coding[].code
string

coding[].display
string

subject
object

reference
string

identifier
object

system
string

value
string

date
string

author
array

author[].reference
string

author[].identifier
object

system
string

value
string

authenticator
object

reference
string

identifier
object

system
string

value
string

custodian
object

reference
string

identifier
object

system
string

value
string

description
string

content
array

content[].attachment
object

contentType
string

url
string

context
object

encounter
array

encounter[].reference
string

encounter[].identifier
object

system
string

value
string

related
array

related[].reference
string

related[].identifier
object

system
string

value
string

entry[].search
object

mode
string

FHIR DocumentReference / Search

get
/FHIR/DocumentReference/

Could not find any active subscriptions

Query parameters

Authorization Scope


HTTP Response

Send a request to view the response

We use cookies to enhance your experience.
For a complete overview of all cookies used, please see our privacy policy.

DIPS ASPostboks 1435, 8037 BodøTlf: +47 75 59 20 00open@dips.no20240220.5