This is the set of resources that conform to either of the profiles IPA-DocumentReference (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference) and DocumentReference Profile for metadata about the document (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-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..* | left: A reference to a document; right: DocumentReference Profile 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 | SΣ | 0..1 | Identifier | Master Version Specific Identifier ele-1: All FHIR elements must have a @value or children | ||||||
identifier | Σ | 0..* | Identifier | Other 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 | 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Σ | 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 | SΣ | 0..* | CodeableConcept | 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Σ | 0..1 | Reference(IPA-Patient | #sd-ipa-patient-profile-patient) | 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(IPA-Practitioner | IPA-PractitionerRole | Organization | Device | IPA-Patient | RelatedPerson | #sd-ipa-practitioner-profile-practitioner) | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children | ||||||
authenticator | S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document ele-1: All FHIR elements must have a @value or children | ||||||
custodian | S | 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 | 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 ipa-doc-1: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | ||||||
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 | SOΣ | 1..1 | code | 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 | SO | 0..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children
| ||||||
url | SOΣ | 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 | 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 | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. ele-1: All FHIR elements must have a @value or children | ||||||
context | SΣ | 0..1 | BackboneElement | 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..* | Reference(Encounter | EpisodeOfCare) | 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 | S | 0..1 | CodeableConcept | left: Additional details about where the content was created (e.g. clinical specialty); right: PractitionerSpecialty Binding: ?? (preferred): left: Additional details about where the content was created (e.g. clinical specialty).; right: Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient. ele-1: All FHIR elements must have a @value or children | ||||||
sourcePatientInfo | S | 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 |