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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a DocumentManifest resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statuscurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptThe code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
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).
createddateTimeWhen 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 the author of the manifest. Manifest author is not necessarly the author of the references included.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourceuriIdentifies 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(Reference)The list of Resources that consist of the parts of this manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a DocumentManifest resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statuscurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptThe code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
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).
createddateTimeWhen 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 the author of the manifest. Manifest author is not necessarly the author of the references included.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourceuriIdentifies 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(Reference)The list of Resources that consist of the parts of this manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response

Read Document Manifest

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Document Manifest

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/DocumentManifest/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Document Manifest

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Document Manifest

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

Request

Headers

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

Query params

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

Params

organizationId*string|stringid|slug

Response

Search History Document Manifest

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
createdstring
descriptionstring
identifierstring
itemstring
patientstring
recipientstring
related-idstring
related-refstring
sourcestring
statusstring
subjectstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a DocumentManifest resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statuscurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptThe code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
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).
createddateTimeWhen 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 the author of the manifest. Manifest author is not necessarly the author of the references included.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourceuriIdentifies 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(Reference)The list of Resources that consist of the parts of this manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response

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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a DocumentManifest resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
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.
statuscurrent|superseded|entered-in-errorThe status of this document manifest.
typeCodeableConceptThe code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
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).
createddateTimeWhen 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 the author of the manifest. Manifest author is not necessarly the author of the references included.
recipientarray(Reference)A patient, practitioner, or organization for which this set of documents is intended.
sourceuriIdentifies 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(Reference)The list of Resources that consist of the parts of this manifest.
relatedarray(DocumentManifest_Related)Related identifiers or resources associated with the DocumentManifest.

Response