USCoreR4 Implementation Guide CI Build

This is the Continuous Integration Build of the USCoreR4 Implementation Guide, based on FHIR Version 3.6.0. See the Directory of published versions

StructureDefinition-us-core-documentreference

This profile sets minimum expectations for searching and fetching patient documents using the DocumentReference Resource. It is compatible with the ITI-68 in IHE MHD specification. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the DocumentReference resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core DocumentReference profile:

  • Query for all documents belonging to a Patient
  • Query for clinical summary information about a patient (access a patient’s Continuity of Care Document (CCD))
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each DocumentReference must have:

  1. a patient
  2. a code describing the type of document
  3. a status
  4. date and time the reference was created (STU3 requirement, removed in R4)
  5. an https address where the document can be retrieved

In addition it should have (if available):

  1. a business identifier for the DocumentReference (possibly generated by the transcription system or EHR)
  2. a document creation date
  3. a code identifying the specific details about the format of the document — over and above the content’s MIME type
  4. the patient encounter date that is being referenced

Profile specific implementation guidance:

For a C-CDA Clinical Summary of Care (CCD):

  • The document type code is the LOINC code 34133-9 Summary of episode note.
  • The format code is urn:hl7-org:sdwg:ccda-structuredBody:2.1
  • The https address may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]) address or a FHIR Document Bundle (i.e [base]/Bundle/[id] address on the server.
Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core-r4/StructureDefinition/us-core-documentreference

Published on Sun Dec 10 00:00:00 PST 2017 as a active by HL7 US Realm Steering Committee.

This profile builds on DocumentReference

Summary of the Mandatory Requirements
  1. One status in DocumentReference.status
  2. One document type code in DocumentReference.type which is bound to Document Type value set
  3. One reference to a patient in DocumentReference.subject
  4. A date and time in DocumentReference.indexed
  5. One url of the document in DocumentReference.content.attachment
    • a mime type in DocumentReference.content.attachment.contentType which is bound to MimeType value set
    • a url of the document in DocumentReference.content.attachment.url

SHOULD have:

  1. One identifier in DocumentReference.identifier
  2. One dateTime value in DocumentReference.created
  3. One format code in DocumentReference.content.format with an extensible binding to DocumentReference format value set
  4. One reference to an encounter in DocumentReference.context.encounter
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*US Core DocumentReference Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier SΣ0..1IdentifierOther identifiers for the document
... status ?!SΣ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
... docStatus Σ0..1codepreliminary | final | appended | amended | entered-in-error
Binding: CompositionStatus (required)
... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentTypeValueSet (required)
... category Σ0..*CodeableConceptCategorization of document
Binding: DocumentClassValueSet (example)
... subject SΣ1..1Reference(US Core Patient Profile)Who/what is the subject of the document
... date SΣ0..1instantWhen this document reference was created
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator 0..1Reference(Practitioner | Organization)Who/what authenticated the document
... custodian 0..1Reference(Organization)Organization which maintains the document
... relatesTo ΣI0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description Σ0..1stringHuman-readable description
... securityLabel Σ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible)
... content SΣI1..1BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣ1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Example General': text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Example General': en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url SΣ1..1urlUri where the data can be found
Example General': http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General': Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... format SΣ0..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (extensible)
... context SΣI0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter S0..1Reference(US Core Encounter Profile)Context of the document content
.... event 0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example)
.... period Σ0..1PeriodTime of service that is being documented
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example)
.... sourcePatientInfo 0..1Reference(Patient)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

Summary

Mandatory: 7 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference I0..*US Core DocumentReference Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier SΣ0..1IdentifierOther identifiers for the document
... status ?!SΣ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
... docStatus Σ0..1codepreliminary | final | appended | amended | entered-in-error
Binding: CompositionStatus (required)
... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DocumentTypeValueSet (required)
... category Σ0..*CodeableConceptCategorization of document
Binding: DocumentClassValueSet (example)
... subject SΣ1..1Reference(US Core Patient Profile)Who/what is the subject of the document
... date SΣ0..1instantWhen this document reference was created
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator 0..1Reference(Practitioner | Organization)Who/what authenticated the document
... custodian 0..1Reference(Organization)Organization which maintains the document
... relatesTo ΣI0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required)
.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description Σ0..1stringHuman-readable description
... securityLabel Σ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible)
... content SΣI1..1BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment SΣ1..1AttachmentWhere to access the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Example General': text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Example General': en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url SΣ1..1urlUri where the data can be found
Example General': http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General': Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... format SΣ0..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (extensible)
... context SΣI0..1BackboneElementClinical context of document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... encounter S0..1Reference(US Core Encounter Profile)Context of the document content
.... event 0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example)
.... period Σ0..1PeriodTime of service that is being documented
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example)
.... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example)
.... sourcePatientInfo 0..1Reference(Patient)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

​Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Typically, DocumentReference resources are used with document indexing systems, such as IHE XDS. However, document references may also may be created “on-the-fly” in response to a Document Query request. In other words there MAY NOT be pre-existing index of references to a patient’s documents at the FHIR endpoint. This results in an empty bundle being returned when searching using a normal FHIR Query. Therefore, the $docref operation has been defined to both create and fetch patient DocumentReference Resources.

The following search criteria describe fetching pre-indexed documents and those created “on-the-fly”.

Searching pre-indexed documents:

GET [base]/DocumentReference?patient=[id]

Example: GET [base]/DocumentReference?patient=2169591

Support: Mandatory to support search by patient.

Implementation Notes: Search for all documents for a patient. Fetches a bundle of all DocumentReference resources for the specified patient (how to search by reference).

GET [base]/DocumentReference?patient=[id]&type=[type]&period=[date]

Example: GET [base]/DocumentReference?patient=2169591&type=34133-9&period=ge2016-01-01

Support: Optional to support search by patient and type and date range.

Implementation Notes: Fetches a bundle of all DocumentReference resources for the specified patient for a given time period and document type. (how to search by reference), (how to search by token), and (how to search by date).

Searching documents using the $docref operation:

Functional behavior of Server when responding to the $docref operation:

  1. SHALL return at least a reference to CCD document, if available, but MAY provide references to other document types as well.
  2. If a context date range is supplied the server SHOULD provide references to any document that falls within the date range
  3. If no date range is supplied, then the server SHALL provide references to last or current encounter

GET [base]/DocumentReference/$docref?patient=[id]

Example: see $docref operation

Support: Mandatory to support response to operation.

Implementation Notes: Search for CCD document from the last encounter and MAY search for other document types from the last encounter as well. Fetches a bundle of DocumentReference resources for the specified patient (how to search by reference).