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 SPLDocumentReference (http://hl7.org/fhir/us/spl/StructureDefinition/SPLDocumentReference). 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: ?? (required): left: A human language.; right: IETF language tag for 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 | left: Additional content defined by implementations; right: Extension 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: Other identifiers for the document; right: Business identifiers for the document ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children |
docStatus | Σ | 0..1 | code | left: preliminary | final | amended | entered-in-error; right: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding Description (No ValueSet): (required): Status of the underlying document. ele-1: All FHIR elements must have a @value or children |
type | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (required): left: All LOINC values whose SCALE is "Doc" in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'; right: Precise type of clinical document. ele-1: All FHIR elements must have a @value or children |
category | SΣ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): left: High-level kind of a clinical document at a macro level.; right: High-level kind of document at a macro level. ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children |
date | SΣ | 0..1 | instant | When this document reference was created ele-1: All FHIR elements must have a @value or children |
author | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | 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 | left: replaces | transforms | signs | appends; right: The relationship type with another document Binding Description (No ValueSet): (extensible): left: The type of relationship between documents.; right: The type of relationship between the documents. ele-1: All FHIR elements must have a @value or children | |
code | code | |||
code | CodeableConcept | |||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship ele-1: All FHIR elements must have a @value or children |
description | Σ | 0..1 | Human-readable description ele-1: All FHIR elements must have a @value or children | |
description | string | |||
description | markdown | |||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): left: Security Labels from the Healthcare Privacy and Security Classification System.; right: Example 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 | 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 | 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 | Mime type of the content, with charset etc. Binding Description (No ValueSet): (required): left: The mime type of an attachment. Any valid mime type is allowed.; right: BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) 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: ?? (required): left: A human language.; right: IETF language tag for a human language. ele-1: All FHIR elements must have a @value or children Example General: en-AU |
data | S | 0..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children |
url | SΣ | 0..1 | url | 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 | Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children | |
size | unsignedInt | |||
size | integer64 | |||
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 |
height | 0..1 | positiveInt | Height of the image in pixels (photo/video) ele-1: All FHIR elements must have a @value or children | |
width | 0..1 | positiveInt | Width of the image in pixels (photo/video) ele-1: All FHIR elements must have a @value or children | |
frames | 0..1 | positiveInt | Number of frames if > 1 (photo) ele-1: All FHIR elements must have a @value or children | |
duration | 0..1 | decimal | Length in seconds (audio / video) ele-1: All FHIR elements must have a @value or children | |
pages | 0..1 | positiveInt | Number of printed pages ele-1: All FHIR elements must have a @value or children | |
format | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (extensible) ele-1: All FHIR elements must have a @value or children |
profile | Σ | 0..* | BackboneElement | Content profile rules for the document ele-1: All FHIR elements must have a @value or children |
context | SΣ | 0..* | left: Clinical context of document; right: Context of the document content ele-1: All FHIR elements must have a @value or children | |
contextAll Types | Content/Rules for all Types | |||
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) | 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 | 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 | |
context | BackboneElement | |||
context | Reference(Appointment | Encounter | EpisodeOfCare) | |||
version | Σ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference ele-1: All FHIR elements must have a @value or children |
basedOn | 0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created ele-1: All FHIR elements must have a @value or children | |
modality | Σ | 0..* | CodeableConcept | Imaging modality used Binding: ?? (extensible): Type of acquired data in the instance. ele-1: All FHIR elements must have a @value or children |
event | 0..* | CodeableReference() | 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 | |
bodySite | Σ | 0..* | CodeableReference(BodyStructure) | Body part included Binding: ?? (example): SNOMED CT Body site concepts ele-1: All FHIR elements must have a @value or children |
facilityType | C | 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 | C | 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 |
period | Σ | 0..1 | Period | Time of service that is being documented ele-1: All FHIR elements must have a @value or children |
attester | 0..* | BackboneElement | Attests to accuracy of the document ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |