This is the set of resources that conform to either of the profiles Document Reference Attachment (http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/cmc-document-reference) and Document Reference Attachment (http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/cmc-document-reference). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | C | 0..* | A reference to a document docRef-1: facilityType SHALL only be present if context is not an encounter docRef-2: practiceSetting SHALL only be present if context is not present 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 | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
versionId | Σ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from ele-1: All FHIR elements must have a @value or children | ||||
profile | SΣ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". 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): 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 | 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 | ||||
identifier | Σ | 0..* | Identifier | Business identifiers for the document ele-1: All FHIR elements must have a @value or children | ||||
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 | |||||
status | ?!Σ | 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 | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: ?? (required): Status of the underlying document. 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 | ||||
type | Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. ele-1: All FHIR elements must have a @value or children | ||||
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of document at a macro level. ele-1: All FHIR elements must have a @value or children | ||||
subject | Σ | 0..1 | Reference(Resource) | Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children | ||||
context | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content 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 | 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 | |||||
period | Σ | 0..1 | Period | Time of service that is being documented ele-1: All FHIR elements must have a @value or children | ||||
date | Σ | 0..1 | instant | When this document reference was created ele-1: All FHIR elements must have a @value or children | ||||
author | Σ | 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 | ||||
attester | 0..* | BackboneElement | Attests to accuracy of the 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 | ||||
mode | 1..1 | CodeableConcept | personal | professional | legal | official Binding: ?? (preferred): The way in which a person authenticated a document. ele-1: All FHIR elements must have a @value or children | |||||
time | 0..1 | dateTime | When the document was attested ele-1: All FHIR elements must have a @value or children | |||||
party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested 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 | CodeableConcept | The relationship type with another document Binding: ?? (extensible): The type of relationship between the 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 | markdown | Human-readable description ele-1: All FHIR elements must have a @value or children | ||||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (example): 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Σ | 1..1 | Attachment | left: Where to access the document; right: Content in a format defined elsewhere ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
contentType | SΣC | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): 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): IETF language tag for a human language.
ele-1: All FHIR elements must have a @value or children Example General: en-AU | ||||
data | SC | 1..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children | ||||
url | Σ | 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 | integer64 | 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 | SΣ | 1..1 | string | Document file name including the file extension 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 | |||||
profile | Σ | 0..* | BackboneElement | Content profile rules for the 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 | ||||
value[x] | Σ | 1..1 | Code|uri|canonical Binding: ?? (preferred): Document Format Codes. ele-1: All FHIR elements must have a @value or children | |||||
valueCoding | Coding | |||||||
valueUri | uri | |||||||
valueCanonical | canonical(Any) | |||||||
Documentation for this format |