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 Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() | 0..* | A reference to a document | ||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (required): left: A human language.; right: IETF language tag for a human language | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | left: Additional content defined by implementations; right: Extension | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..1 | Identifier | Master Version Specific Identifier |
![]() ![]() ![]() | SΣ | 0..* | Identifier | left: Other identifiers for the document; right: Business identifiers for the document |
![]() ![]() ![]() | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. |
![]() ![]() ![]() | Σ | 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: (required) ⚠: Status of the underlying document. |
![]() ![]() ![]() | 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. |
![]() ![]() ![]() | 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. |
![]() ![]() ![]() | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document |
![]() ![]() ![]() | SΣ | 0..1 | instant | When this document reference was created |
![]() ![]() ![]() | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document |
![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |
![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization which maintains the document | |
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Relationships to other documents |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | left: replaces | transforms | signs | appends; right: The relationship type with another document Binding Description: (extensible) ⚠: left: The type of relationship between documents.; right: The type of relationship between the documents. | |
![]() ![]() ![]() ![]() ![]() | code | |||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
![]() ![]() ![]() | Σ | 0..1 | Human-readable description | |
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() | markdown | |||
![]() ![]() ![]() | Σ | 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. |
![]() ![]() ![]() | SΣ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣC | 1..1 | Attachment | Where to access the document Constraints: us-core-6 |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding Description: (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) Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (required): left: A human language.; right: IETF language tag for a human language. Example General: en-AU |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Number of bytes of content (if url provided) | |
![]() ![]() ![]() ![]() ![]() ![]() | unsignedInt | |||
![]() ![]() ![]() ![]() ![]() ![]() | integer64 | |||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() ![]() ![]() | 0..1 | positiveInt | Height of the image in pixels (photo/video) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | positiveInt | Number of frames if > 1 (photo) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | decimal | Length in seconds (audio / video) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | positiveInt | Number of printed pages | |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (extensible) |
![]() ![]() ![]() ![]() | Σ | 0..* | BackboneElement | Content profile rules for the document |
![]() ![]() ![]() | SΣ | 0..* | left: Clinical context of document; right: Context of the document content | |
![]() ![]() ![]() ![]() | Content/Rules for all Types | |||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content |
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time of service that is being documented |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. | |
![]() ![]() ![]() ![]() ![]() | 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). | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Patient) | Patient demographics from source | |
![]() ![]() ![]() ![]() ![]() | 0..* | Reference(Resource) | Related identifiers or resources | |
![]() ![]() ![]() ![]() | BackboneElement | |||
![]() ![]() ![]() ![]() | Reference(Appointment | Encounter | EpisodeOfCare) | |||
![]() ![]() ![]() | SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference |
![]() ![]() ![]() | 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 | |
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Imaging modality used Binding: ?? (extensible): Type of acquired data in the instance. |
![]() ![]() ![]() | 0..* | CodeableReference() | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | |
![]() ![]() ![]() | Σ | 0..* | CodeableReference(BodyStructure) | Body part included Binding: ?? (example): SNOMED CT Body site concepts |
![]() ![]() ![]() | C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. |
![]() ![]() ![]() | 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). |
![]() ![]() ![]() | Σ | 0..1 | Period | Time of service that is being documented |
![]() ![]() ![]() | 0..* | BackboneElement | Attests to accuracy of the document | |
![]() |