DocumentReference Conditional Delete

delete

DocumentReference Conditional Delete

The conditional delete interaction allows a client to delete DocumentReference/DocumentReferences based on some selection criteria, rather than by a specific 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
  • 204
    204

    No Content.

  • 404
    404

    DocumentReference not found.

  • 405
    405

    Method not allowed.

  • 409
    409

    Conflict Error.

  • 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.

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)

Working...