document references

Create Document Reference

post
/organizations/{organizationId}/fhir/3/DocumentReference

A reference to a document.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringDocumentReferenceThis is a DocumentReference resource
masterIdentifierIdentifierDocument identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
identifierarray(Identifier)Other identifiers associated with the document, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document reference.
docStatusstringThe status of the underlying document.
type*CodeableConceptSpecifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
classCodeableConceptA categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
subjectReferenceWho or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
createdstringWhen the document was created.
indexedstringWhen the document reference was created.
authorarray(Reference)Identifies who is responsible for adding the information to the document.
authenticatorReferenceWhich person or organization authenticates that this document is valid.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document.
relatesToarray(DocumentReference_RelatesTo)Relationships that this document has with other document references that already exist.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
securityLabelarray(CodeableConcept)A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
content*array(DocumentReference_Content)The document and format referenced. There may be multiple content element repetitions, each with a different format.
contextDocumentReference_ContextThe clinical context in which the document was prepared.

Response

Patch Document Reference

patch
/organizations/{organizationId}/fhir/3/DocumentReference/{resourceId}

A reference to a document.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDocumentReferenceThis is a DocumentReference resource
masterIdentifierIdentifierDocument identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
identifierarray(Identifier)Other identifiers associated with the document, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document reference.
docStatusstringThe status of the underlying document.
type*CodeableConceptSpecifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
classCodeableConceptA categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
subjectReferenceWho or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
createdstringWhen the document was created.
indexedstringWhen the document reference was created.
authorarray(Reference)Identifies who is responsible for adding the information to the document.
authenticatorReferenceWhich person or organization authenticates that this document is valid.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document.
relatesToarray(DocumentReference_RelatesTo)Relationships that this document has with other document references that already exist.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
securityLabelarray(CodeableConcept)A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
content*array(DocumentReference_Content)The document and format referenced. There may be multiple content element repetitions, each with a different format.
contextDocumentReference_ContextThe clinical context in which the document was prepared.

Response

Read Document Reference

get
/organizations/{organizationId}/fhir/3/DocumentReference/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Document Reference

get
/organizations/{organizationId}/fhir/3/DocumentReference/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Document Reference

get
/organizations/{organizationId}/fhir/3/DocumentReference/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Document Reference

delete
/organizations/{organizationId}/fhir/3/DocumentReference/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Document Reference

get
/organizations/{organizationId}/fhir/3/DocumentReference

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authenticatorstring
authorstring
classstring
createdstring
custodianstring
descriptionstring
encounterstring
eventstring
facilitystring
formatstring
identifierstring
indexedstring
languagestring
locationstring
patientstring
periodstring
related-idstring
related-refstring
relatestostring
relationstring
relationshipstring
securitylabelstring
settingstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Document Reference

get
/organizations/{organizationId}/fhir/3/DocumentReference/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Document Reference

post
/organizations/{organizationId}/fhir/3/DocumentReference/_search

A reference to a document.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authenticatorstring
authorstring
classstring
createdstring
custodianstring
descriptionstring
encounterstring
eventstring
facilitystring
formatstring
identifierstring
indexedstring
languagestring
locationstring
patientstring
periodstring
related-idstring
related-refstring
relatestostring
relationstring
relationshipstring
securitylabelstring
settingstring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDocumentReferenceThis is a DocumentReference resource
masterIdentifierIdentifierDocument identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
identifierarray(Identifier)Other identifiers associated with the document, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document reference.
docStatusstringThe status of the underlying document.
type*CodeableConceptSpecifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
classCodeableConceptA categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
subjectReferenceWho or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
createdstringWhen the document was created.
indexedstringWhen the document reference was created.
authorarray(Reference)Identifies who is responsible for adding the information to the document.
authenticatorReferenceWhich person or organization authenticates that this document is valid.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document.
relatesToarray(DocumentReference_RelatesTo)Relationships that this document has with other document references that already exist.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
securityLabelarray(CodeableConcept)A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
content*array(DocumentReference_Content)The document and format referenced. There may be multiple content element repetitions, each with a different format.
contextDocumentReference_ContextThe clinical context in which the document was prepared.

Response

Update Document Reference

put
/organizations/{organizationId}/fhir/3/DocumentReference/{resourceId}

A reference to a document.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDocumentReferenceThis is a DocumentReference resource
masterIdentifierIdentifierDocument identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
identifierarray(Identifier)Other identifiers associated with the document, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document reference.
docStatusstringThe status of the underlying document.
type*CodeableConceptSpecifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
classCodeableConceptA categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
subjectReferenceWho or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
createdstringWhen the document was created.
indexedstringWhen the document reference was created.
authorarray(Reference)Identifies who is responsible for adding the information to the document.
authenticatorReferenceWhich person or organization authenticates that this document is valid.
custodianReferenceIdentifies the organization or group who is responsible for ongoing maintenance of and access to the document.
relatesToarray(DocumentReference_RelatesTo)Relationships that this document has with other document references that already exist.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
securityLabelarray(CodeableConcept)A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
content*array(DocumentReference_Content)The document and format referenced. There may be multiple content element repetitions, each with a different format.
contextDocumentReference_ContextThe clinical context in which the document was prepared.

Response