DocumentManifest - FHIR Resource (stu3)


This DocumentManifest Resource uses the FHIR API standard for access and structure.

Resource Attributes

AttributeField is listTypeDescription
authortrueReference "author" : [{ Reference(Practitioner|Organization|Device|Patient|
contenttrueData Type The items included
createdfalsedateTime When this document manifest created
descriptionfalsestring Human-readable description (title)
identifiertrueIdentifier Other identifiers for the manifest
masterIdentifierfalseIdentifier Unique Identifier for the set of documents
recipienttrueReference Intended to get notified about this set of documents
relatedtrueData Type Related things
sourcefalseuri The source system/application/software
statusfalsecode current | superseded | entered-in-error
subjectfalseReference The subject of the set of documents
typefalseCodeableConcept Kind of document set

DocumentManifest Example

{
  "status": "current",
  "author": [
    {
      "reference": "#a1"
    }
  ],
  "masterIdentifier": {
    "system": "http://example.org/documents",
    "value": "23425234234-2346"
  },
  "resourceType": "DocumentManifest",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Text</div>"
  },
  "description": "Physical",
  "created": "2004-12-25T23:50:50-05:00",
  "recipient": [
    {
      "reference": "Practitioner/xcda1"
    }
  ],
  "related": [
    {
      "identifier": {
        "system": "http://example.org/documents",
        "value": "23425234234-9999"
      },
      "ref": {
        "reference": "DocumentReference/example"
      }
    }
  ],
  "content": [
    {
      "pReference": {
        "reference": "DocumentReference/example"
      }
    }
  ],
  "source": "urn:oid:1.3.6.1.4.1.21367.2009.1.2.1",
  "contained": [
    {
      "resourceType": "Practitioner",
      "telecom": [
        {
          "system": "email",
          "value": "john.doe@healthcare.example.org"
        }
      ],
      "id": "a1",
      "name": [
        {
          "given": [
            "Sherry"
          ],
          "family": "Dopplemeyer"
        }
      ]
    }
  ],
  "identifier": [
    {
      "system": "http://example.org/documents",
      "value": "23425234234-2347"
    }
  ],
  "type": {
    "text": "History and Physical"
  },
  "id": "example",
  "subject": {
    "reference": "Patient/xcda"
  }
}

DocumentManifest Structure


  
{
  "resourceType" : "DocumentManifest",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "masterIdentifier" : { Identifier }, // Unique Identifier for the set of documents
  "identifier" : [{ Identifier }], // Other identifiers for the manifest
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "type" : { CodeableConcept }, // Kind of document set
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // The subject of the set of documents
  "created" : "<dateTime>", // When this document manifest created
  "author" : [{ Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) }], // Who and/or what authored the manifest
  "recipient" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization) }], // Intended to get notified about this set of documents
  "source" : "<uri>", // The source system/application/software
  "description" : "<string>", // Human-readable description (title)
  "content" : [{ // R!  The items included
    // p[x]: Contents of this set of documents. One of these 2:
    "pAttachment" : { Attachment }
    "pReference" : { Reference(Any) }
  }],
  "related" : [{ // Related things
    "identifier" : { Identifier }, // Identifiers of things that are related
    "ref" : { Reference(Any) } // Related Resource
  }]
}


 

DocumentManifest Search Parameters

The following search parameters can be used to query DocumentManifest resources. Just submit the like so:

https://api.1up.health/fhir/stu3/DocumentManifest?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authorreferenceauthor
content-refreferencecontent.p.as
createddatecreated
descriptiontextdescription
identifiertextmasterIdentifier, identifier
patientreferencesubject
recipientreferencerecipient
related-idtextrelated.identifier
related-refreferencerelated.ref
sourceurisource
statustextstatus
subjectreferencesubject
typetexttype