DocumentReference Conditional Update

put

DocumentReference Conditional Update

The conditional update interaction is used to update an existing DocumentReference based on some identification criteria, rather than by logical id.

FHIR documentation for DocumentReference.

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    DocumentReference could not be parsed or failed basic FHIR validation rules (or multiple matches were found).

  • 403
    403

    Not Authorized.

  • 412
    412

    The given criteria is not selective enough.

Environment URL
Live

https://fhirsandbox-prod.apigee.net/fhir/v1/DocumentReference

Name Values Description
Authorization

Specify access token for API in the given format: Bearer [access_token].

Accept

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

Content-Type
(required)

Specifies the format of data in body

Name Values Description
_content

Search the contents of the resource's data using a fulltext search

_id

The resource identity

_language

The resource language

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

_profile

Search for resources which have the given profile

_security

Search for resources which have the given security labels

_tag

Search for resources which have the given tag

_text

Search the contents of the resource's narrative using a fulltext search

authenticator

Who/what authenticated the document

author

Who and/or what authored the document

class

Categorization of document

created

Document creation time. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

created

Document creation time. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

custodian

Organization which maintains the document

description

Human-readable description (title)

encounter

Context of the document content

event

Main Clinical Acts Documented

facility

Kind of facility where patient was seen

format

Format/content rules for the document

identifier

Master Version Specific Identifier

indexed

When this document reference created. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

indexed

When this document reference created. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

language

Human language of the content (BCP-47)

location

Uri where the data can be found

patient

Who/what is the subject of the document

period

Time of service that is being documented. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

period

Time of service that is being documented. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

related-id

Identifier of related objects or events

related-ref

Related Resource

relatesto

Target of the relationship

relatesto-relation

Combination of relation and relatesTo

relation

replaces | transforms | signs | appends

securitylabel

Document security-tags

setting

Additional details about where the content was created (e.g. clinical specialty)

status

current | superseded | entered-in-error

subject

Who/what is the subject of the document

type

Kind of document (LOINC if possible)

The request body should be a valid data payload.

Working...