document manifests

Create Document Manifest

post

/organizations/{organizationId}/fhir/4/DocumentManifest

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a DocumentManifest resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
masterIdentifier	Identifier		A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifier	array(Identifier)		Other identifiers associated with the document manifest, including version independent identifiers.
status		current\|superseded\|entered-in-error	The status of this document manifest.
type	CodeableConcept		The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
subject	Reference		Who 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).
created	dateTime		When 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.).
author	array(Reference)		Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
recipient	array(Reference)		A patient, practitioner, or organization for which this set of documents is intended.
source	uri		Identifies the source system, application, or software that produced the document manifest.
description	string		Human-readable description of the source document. This is sometimes known as the "title".
content*	array(Reference)		The list of Resources that consist of the parts of this manifest.
related	array(DocumentManifest_Related)		Related identifiers or resources associated with the DocumentManifest.

Response

201 400 401 404

Patch Document Manifest

patch

/organizations/{organizationId}/fhir/4/DocumentManifest/{resourceId}

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

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a DocumentManifest resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
masterIdentifier	Identifier		A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifier	array(Identifier)		Other identifiers associated with the document manifest, including version independent identifiers.
status		current\|superseded\|entered-in-error	The status of this document manifest.
type	CodeableConcept		The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
subject	Reference		Who 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).
created	dateTime		When 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.).
author	array(Reference)		Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
recipient	array(Reference)		A patient, practitioner, or organization for which this set of documents is intended.
source	uri		Identifies the source system, application, or software that produced the document manifest.
description	string		Human-readable description of the source document. This is sometimes known as the "title".
content*	array(Reference)		The list of Resources that consist of the parts of this manifest.
related	array(DocumentManifest_Related)		Related identifiers or resources associated with the DocumentManifest.

Response

200 201 400 401 404 409

Read Document Manifest

get

/organizations/{organizationId}/fhir/4/DocumentManifest/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Document Manifest

get

/organizations/{organizationId}/fhir/4/DocumentManifest/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Document Manifest

get

/organizations/{organizationId}/fhir/4/DocumentManifest/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Document Manifest

delete

/organizations/{organizationId}/fhir/4/DocumentManifest/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Document Manifest

get

/organizations/{organizationId}/fhir/4/DocumentManifest

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
author	string
created	string
description	string
identifier	string
item	string
patient	string
recipient	string
related-id	string
related-ref	string
source	string
status	string
subject	string
type	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Document Manifest

get

/organizations/{organizationId}/fhir/4/DocumentManifest/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Document Manifest

post

/organizations/{organizationId}/fhir/4/DocumentManifest/_search

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

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
author	string
created	string
description	string
identifier	string
item	string
patient	string
recipient	string
related-id	string
related-ref	string
source	string
status	string
subject	string
type	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a DocumentManifest resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
masterIdentifier	Identifier		A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifier	array(Identifier)		Other identifiers associated with the document manifest, including version independent identifiers.
status		current\|superseded\|entered-in-error	The status of this document manifest.
type	CodeableConcept		The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
subject	Reference		Who 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).
created	dateTime		When 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.).
author	array(Reference)		Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
recipient	array(Reference)		A patient, practitioner, or organization for which this set of documents is intended.
source	uri		Identifies the source system, application, or software that produced the document manifest.
description	string		Human-readable description of the source document. This is sometimes known as the "title".
content*	array(Reference)		The list of Resources that consist of the parts of this manifest.
related	array(DocumentManifest_Related)		Related identifiers or resources associated with the DocumentManifest.

Response

200 401 404

Update Document Manifest

put

/organizations/{organizationId}/fhir/4/DocumentManifest/{resourceId}

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a DocumentManifest resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
masterIdentifier	Identifier		A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifier	array(Identifier)		Other identifiers associated with the document manifest, including version independent identifiers.
status		current\|superseded\|entered-in-error	The status of this document manifest.
type	CodeableConcept		The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
subject	Reference		Who 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).
created	dateTime		When 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.).
author	array(Reference)		Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
recipient	array(Reference)		A patient, practitioner, or organization for which this set of documents is intended.
source	uri		Identifies the source system, application, or software that produced the document manifest.
description	string		Human-readable description of the source document. This is sometimes known as the "title".
content*	array(Reference)		The list of Resources that consist of the parts of this manifest.
related	array(DocumentManifest_Related)		Related identifiers or resources associated with the DocumentManifest.

Response

200 201 400 401 404 409