document manifests

Create Document Manifest

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

A collection of documents compiled for a purpose together with metadata that applies to the collection.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringDocumentManifestThis is a DocumentManifest resource
masterIdentifierIdentifierA single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifierarray(Identifier)Other identifiers associated with the document manifest, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptSpecifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
subjectReferenceWho or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
createdstringWhen the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
authorarray(Reference)Identifies who is responsible for creating the manifest, and adding documents to it.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourcestringIdentifies the source system, application, or software that produced the document manifest.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
content*array(DocumentManifest_Content)The list of Documents included in the manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response

Patch Document Manifest

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

A collection of documents compiled for a purpose together with metadata that applies to the collection.

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*stringDocumentManifestThis is a DocumentManifest resource
masterIdentifierIdentifierA single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifierarray(Identifier)Other identifiers associated with the document manifest, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptSpecifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
subjectReferenceWho or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
createdstringWhen the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
authorarray(Reference)Identifies who is responsible for creating the manifest, and adding documents to it.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourcestringIdentifies the source system, application, or software that produced the document manifest.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
content*array(DocumentManifest_Content)The list of Documents included in the manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response

Read Document Manifest

get
/organizations/{organizationId}/fhir/3/DocumentManifest/{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 Manifest

get
/organizations/{organizationId}/fhir/3/DocumentManifest/{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 Manifest

get
/organizations/{organizationId}/fhir/3/DocumentManifest/{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 Manifest

delete
/organizations/{organizationId}/fhir/3/DocumentManifest/{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 Manifest

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

Request

Headers

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

Query params

_idstring
_languagestring
authorstring
content-refstring
createdstring
descriptionstring
identifierstring
patientstring
recipientstring
related-idstring
related-refstring
sourcestring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Document Manifest

get
/organizations/{organizationId}/fhir/3/DocumentManifest/_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 Manifest

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

A collection of documents compiled for a purpose together with metadata that applies to the collection.

Request

Headers

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

Query params

_idstring
_languagestring
authorstring
content-refstring
createdstring
descriptionstring
identifierstring
patientstring
recipientstring
related-idstring
related-refstring
sourcestring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDocumentManifestThis is a DocumentManifest resource
masterIdentifierIdentifierA single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifierarray(Identifier)Other identifiers associated with the document manifest, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptSpecifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
subjectReferenceWho or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
createdstringWhen the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
authorarray(Reference)Identifies who is responsible for creating the manifest, and adding documents to it.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourcestringIdentifies the source system, application, or software that produced the document manifest.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
content*array(DocumentManifest_Content)The list of Documents included in the manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response

Update Document Manifest

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

A collection of documents compiled for a purpose together with metadata that applies to the collection.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDocumentManifestThis is a DocumentManifest resource
masterIdentifierIdentifierA single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifierarray(Identifier)Other identifiers associated with the document manifest, including version independent identifiers.
statusstringcurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptSpecifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
subjectReferenceWho or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
createdstringWhen the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
authorarray(Reference)Identifies who is responsible for creating the manifest, and adding documents to it.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourcestringIdentifies the source system, application, or software that produced the document manifest.
descriptionstringHuman-readable description of the source document. This is sometimes known as the "title".
content*array(DocumentManifest_Content)The list of Documents included in the manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response