This is the set of resources that conform to either of the profiles US Core DocumentReference Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference) and US Core DocumentReference Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | A reference to a document dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier ele-1: All FHIR elements must have a @value or children |
identifier | SΣ | 0..* | Identifier | left: (USCDI) Other identifiers for the document; right: Other identifiers for the document ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | left: (USCDI) current | superseded | entered-in-error; right: current | superseded | entered-in-error Binding: ?? (required) ele-1: All FHIR elements must have a @value or children |
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required): Status of the underlying document. ele-1: All FHIR elements must have a @value or children |
type | SΣ | 1..1 | CodeableConcept | left: (USCDI) Kind of document (LOINC if possible); right: Kind of document (LOINC if possible) Binding: ?? (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown' ele-1: All FHIR elements must have a @value or children |
category | SΣ | 1..* | CodeableConcept | left: (USCDI) Categorization of document; right: Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 1..1 | Reference(US Core Patient Profile | #sd-us-core-patient-us-core-patient) | left: (USCDI) Who/what is the subject of the document; right: Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children |
date | SΣ | 0..1 | instant | left: (USCDI) When this document reference was created; right: When this document reference was created ele-1: All FHIR elements must have a @value or children |
author | SΣ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | Device | #sd-us-core-practitioner-us-core-practitioner) | left: (USCDI) Who and/or what authored the document; right: Who and/or what authored the document ele-1: All FHIR elements must have a @value or children |
authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document ele-1: All FHIR elements must have a @value or children | |
custodian | 0..1 | Reference(Organization) | Organization which maintains the document ele-1: All FHIR elements must have a @value or children | |
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: ?? (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children |
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship ele-1: All FHIR elements must have a @value or children |
description | Σ | 0..1 | string | Human-readable description ele-1: All FHIR elements must have a @value or children |
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children |
content | SΣ | 1..* | BackboneElement | left: (USCDI) Document referenced; right: Document referenced ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
attachment | SΣC | 1..1 | Attachment | left: (USCDI) Where to access the document; right: Where to access the document ele-1: All FHIR elements must have a @value or children us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
contentType | SΣ | 0..1 | code | left: (USCDI) Mime type of the content, with charset etc.; right: Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png |
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children Example General: en-AU |
data | S | 0..1 | base64Binary | left: (USCDI) Data inline, base64ed; right: Data inline, base64ed ele-1: All FHIR elements must have a @value or children |
url | SΣ | 0..1 | url | left: (USCDI) Uri where the data can be found; right: Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png |
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children |
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children |
title | Σ | 0..1 | string | Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo |
creation | Σ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children |
format | SΣ | 0..1 | Coding | left: (USCDI) Format/content rules for the document; right: Format/content rules for the document Binding: ?? (extensible) ele-1: All FHIR elements must have a @value or children |
context | SΣ | 0..1 | BackboneElement | left: (USCDI) Clinical context of document; right: Clinical context of document ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
encounter | S | 0..1 | Reference(US Core Encounter Profile | #sd-us-core-encounter-us-core-encounter) | left: (USCDI) Context of the document content; right: Context of the document content ele-1: All FHIR elements must have a @value or children |
event | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. ele-1: All FHIR elements must have a @value or children | |
period | SΣ | 0..1 | Period | left: (USCDI) Time of service that is being documented; right: Time of service that is being documented ele-1: All FHIR elements must have a @value or children |
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. ele-1: All FHIR elements must have a @value or children | |
practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). ele-1: All FHIR elements must have a @value or children | |
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source ele-1: All FHIR elements must have a @value or children | |
related | 0..* | Reference(Resource) | Related identifiers or resources ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |