Source | hl7.fhir.us.core#current:US Core Implementation Guide (v4.0.1) |
resourceType | StructureDefinition |
id | us-core-documentreference |
canonical | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference |
version | 7.0.0-ballot |
status | active |
publisher | HL7 International - Cross-Group Projects |
name | USCoreDocumentReferenceProfile |
title | US Core DocumentReference Profile |
date | 2022-04-20 |
experimental | false |
description | To promote interoperability and adoption through common implementation, this profile sets minimum expectations for searching and fetching patient documents including Clinical Notes using the DocumentReference resource. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases. Prior to reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of US Core DocumentReference Profile and US Core DiagnosticReport Profile for Report and Note exchange. |
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
jurisdictions | us |
fhirVersion | 4.0.1 |
kind | resource |
abstract | false |
sdTtype | DocumentReference |
derivation | constraint |
base | http://hl7.org/fhir/StructureDefinition/DocumentReference |
Usages |
|
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | DocumentReference | |||||||
identifier | S | (USCDI) Other identifiers for the document | ||||||
status | S |
(USCDI) current | superseded | entered-in-error Binding: DocumentReferenceStatus ( required ) |
||||||
type | S | 1.. |
(USCDI) Kind of document (LOINC if possible) Binding: US Core DocumentReference Type ( required ): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
|
|||||
Slices for category | S | 1 .. |
(USCDI) Categorization of document
Slice: Unordered, Open by pattern:$this |
|||||
category:uscore |
(USCDI) Categorization of document Binding: US Core DocumentReference Category ( required ): The US Core DocumentReferences Type Value Set is a "starter set" of categories supported for fetching and storing clinical notes. Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
|||||||
subject | S | 1.. | Reference (US Core Patient Profile) | (USCDI) Who/what is the subject of the document | ||||
date | S | (USCDI) When this document reference was created | ||||||
author | S | Reference (US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device ) | (USCDI) Who and/or what authored the document | |||||
content | S | (USCDI) Document referenced | ||||||
attachment | S C |
(USCDI) Where to access the document us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. |
||||||
contentType | S | (USCDI) Mime type of the content, with charset etc. | ||||||
data | S C | 0.. | (USCDI) Data inline, base64ed | |||||
url | S C | 0.. | (USCDI) Uri where the data can be found | |||||
format | S |
(USCDI) Format/content rules for the document Binding: todo ( extensible ) |
||||||
context | S | (USCDI) Clinical context of document | ||||||
encounter | S | ..1 | Reference (US Core Encounter Profile) | (USCDI) Context of the document content | ||||
period | S | (USCDI) Time of service that is being documented | ||||||
Documentation for this format |
Produced 08 Sep 2023