DocumentReference - FHIR Resource (dstu2)


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

Resource Attributes

AttributeField is listTypeDescription
authenticatorfalseReference Who/what authenticated the document
authortrueReference "author" : [{ Reference(Practitioner|Organization|Device|Patient|
classfalseCodeableConcept Categorization of document
contenttrueData Type Document referenced
contextfalseData Type Clinical context of document
createdfalsedateTime Document creation time
custodianfalseReference Organization which maintains the document
descriptionfalsestring Human-readable description (title)
docStatusfalseCodeableConcept preliminary | final | appended | amended | entered-in-error
identifiertrueIdentifier Other identifiers for the document
indexedfalseinstant When this document reference created
masterIdentifierfalseIdentifier Master Version Specific Identifier
relatesTotrueData Type Relationships to other documents
securityLabeltrueCodeableConcept Document security-tags
statusfalsecode current | superseded | entered-in-error
subjectfalseReference Who/what is the subject of the document
typefalseCodeableConcept Kind of document (LOINC if possible)

DocumentReference Structure


  
{
  "resourceType" : "DocumentReference",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "masterIdentifier" : { Identifier }, // Master Version Specific Identifier
  "identifier" : [{ Identifier }], // Other identifiers for the document
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // Who/what is the subject of the document
  "type" : { CodeableConcept }, // R!  Kind of document (LOINC if possible)
  "class" : { CodeableConcept }, // Categorization of document
  "author" : [{ Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) }], // Who and/or what authored the document
  "custodian" : { Reference(Organization) }, // Organization which maintains the document
  "authenticator" : { Reference(Practitioner|Organization) }, // Who/what authenticated the document
  "created" : "<dateTime>", // Document creation time
  "indexed" : "<instant>", // R!  When this document reference created
  "status" : "<code>", // R!  current | superseded | entered-in-error
  "docStatus" : { CodeableConcept }, // preliminary | final | appended | amended | entered-in-error
  "relatesTo" : [{ // Relationships to other documents
    "code" : "<code>", // R!  replaces | transforms | signs | appends
    "target" : { Reference(DocumentReference) } // R!  Target of the relationship
  }],
  "description" : "<string>", // Human-readable description (title)
  "securityLabel" : [{ CodeableConcept }], // Document security-tags
  "content" : [{ // R!  Document referenced
    "attachment" : { Attachment }, // R!  Where to access the document
    "format" : [{ Coding }] // Format/content rules for the document
  }],
  "context" : { // Clinical context of document
    "encounter" : { Reference(Encounter) }, // Context of the document  content
    "event" : [{ CodeableConcept }], // Main Clinical Acts Documented
    "period" : { Period }, // Time of service that is being documented
    "facilityType" : { CodeableConcept }, // Kind of facility where patient was seen
    "practiceSetting" : { CodeableConcept }, // Additional details about where the content was created (e.g. clinical specialty)
    "sourcePatientInfo" : { Reference(Patient) }, // Patient demographics from source
    "related" : [{ // Related identifiers or resources
      "identifier" : { Identifier }, // Identifier of related objects or events
      "ref" : { Reference(Any) } // Related Resource
    }]
  }
}


 

DocumentReference Search Parameters

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

https://api.1up.health/fhir/dstu2/DocumentReference?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authenticatorreferenceauthenticator
authorreferenceauthor
classtextclass
createddatecreated
custodianreferencecustodian
descriptiontextdescription
encounterreferencecontext.encounter
eventtextcontext.event
facilitytextcontext.facilityType
formattextcontent.format
identifiertextmasterIdentifier, DocumentReference.identifier
indexeddateindexed
languagetextcontent.attachment.language
locationuricontent.attachment.url
patientreferencesubject
perioddatecontext.period
related-idtextcontext.related.identifier
related-refreferencecontext.related.ref
relatestoreferencerelatesTo.target
relationtextrelatesTo.code
relationshipcomposite
securitylabeltextsecurityLabel
settingtextcontext.practiceSetting
statustextstatus
subjectreferencesubject
typetexttype