Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R2_DocumentReference_R4

Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-DocumentReference Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R2_DocumentReference_R4

This cross-version profile allows DSTU2 DocumentReference content to be represented via FHIR R4 DocumentReference resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.0.1) A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:created 0..1 dateTime DSTU2: Document creation time (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.created
Constraints: ext-1
.... extension:indexed 1..1 instant DSTU2: When this document reference created (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.indexed
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..* BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:attachment 1..1 Attachment DSTU2: attachment additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.content.attachment
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error DocumentReference.implicitRules, DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.status, DocumentReference.content, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.0.1) A reference to a document
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.text
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:created 0..1 dateTime DSTU2: Document creation time (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.created
.... extension:indexed 1..1 instant DSTU2: When this document reference created (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.indexed
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:masterIdentifier 0..1 Identifier DSTU2: masterIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.masterIdentifier
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.identifier
... docStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:docStatus 0..1 CodeableConcept DSTU2: preliminary | final | appended | amended | entered-in-error additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: CompositionStatus (required): Status of the underlying document.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) DSTU2: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Resource) DSTU2: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... authenticator
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authenticator 0..1 Reference(Resource) DSTU2: authenticator additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 Reference(Resource) DSTU2: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relatesTo
.... target
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 Reference(Resource) DSTU2: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... content
.... attachment
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:attachment 0..1 Attachment DSTU2: attachment additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.content.attachment
... context
.... encounter
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:encounter 0..1 Reference(Resource) DSTU2: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.period
.... sourcePatientInfo
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sourcePatientInfo 0..1 Reference(Resource) DSTU2: sourcePatientInfo additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... related
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:identifier 0..1 Identifier DSTU2: Identifier of related objects or events (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.related.identifier
...... extension:ref 0..1 Reference(Resource) DSTU2: Related Resource additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.0.1) A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:created 0..1 dateTime DSTU2: Document creation time (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.created
Constraints: ext-1
.... extension:indexed 1..1 instant DSTU2: When this document reference created (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.indexed
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:masterIdentifier 0..1 Identifier DSTU2: masterIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.masterIdentifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... identifier Σ 0..* Identifier Other identifiers for the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:docStatus 0..1 CodeableConcept DSTU2: preliminary | final | appended | amended | entered-in-error additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: CompositionStatus (required): Status of the underlying document.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) DSTU2: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:author 0..1 Reference(Resource) DSTU2: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:authenticator 0..1 Reference(Resource) DSTU2: authenticator additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... custodian 0..1 Reference(Organization) Organization which maintains the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:custodian 0..1 Reference(Resource) DSTU2: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:target 0..1 Reference(Resource) DSTU2: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:attachment 1..1 Attachment DSTU2: attachment additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.content.attachment
Constraints: ext-1
..... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:encounter 0..1 Reference(Resource) DSTU2: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:sourcePatientInfo 0..1 Reference(Resource) DSTU2: sourcePatientInfo additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... related 0..* Reference(Resource) Related identifiers or resources
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:identifier 0..1 Identifier DSTU2: Identifier of related objects or events (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.related.identifier
Constraints: ext-1
...... extension:ref 0..1 Reference(Resource) DSTU2: Related Resource additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.text.​status Base required NarrativeStatus 📍4.0.1 FHIR Std.
DocumentReference.masterIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.masterIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.subject.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.author.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.authenticator.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.custodian.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​target.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.securityLabel Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​encounter.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.context.​event Base example v3 Code System ActCode 📍3.0.0 THO v7.1
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.context.​related.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error DocumentReference.meta, DocumentReference.meta.extension, DocumentReference.meta.extension:meta, DocumentReference.meta.versionId, DocumentReference.meta.lastUpdated, DocumentReference.meta.source, DocumentReference.meta.profile, DocumentReference.meta.security, DocumentReference.meta.tag, DocumentReference.implicitRules, DocumentReference.language, DocumentReference.text, DocumentReference.text.extension, DocumentReference.text.extension:text, DocumentReference.text.status, DocumentReference.text.div, DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.masterIdentifier, DocumentReference.masterIdentifier.extension, DocumentReference.masterIdentifier.extension:masterIdentifier, DocumentReference.masterIdentifier.use, DocumentReference.masterIdentifier.type, DocumentReference.masterIdentifier.system, DocumentReference.masterIdentifier.value, DocumentReference.masterIdentifier.period, DocumentReference.masterIdentifier.assigner, DocumentReference.identifier, DocumentReference.identifier.extension, DocumentReference.identifier.extension:identifier, DocumentReference.identifier.use, DocumentReference.identifier.type, DocumentReference.identifier.system, DocumentReference.identifier.value, DocumentReference.identifier.period, DocumentReference.identifier.assigner, DocumentReference.status, DocumentReference.docStatus, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.type, DocumentReference.category, DocumentReference.subject, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.subject.reference, DocumentReference.subject.type, DocumentReference.subject.identifier, DocumentReference.subject.display, DocumentReference.date, DocumentReference.author, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.author.reference, DocumentReference.author.type, DocumentReference.author.identifier, DocumentReference.author.display, DocumentReference.authenticator, DocumentReference.authenticator.extension, DocumentReference.authenticator.extension:authenticator, DocumentReference.authenticator.reference, DocumentReference.authenticator.type, DocumentReference.authenticator.identifier, DocumentReference.authenticator.display, DocumentReference.custodian, DocumentReference.custodian.extension, DocumentReference.custodian.extension:custodian, DocumentReference.custodian.reference, DocumentReference.custodian.type, DocumentReference.custodian.identifier, DocumentReference.custodian.display, DocumentReference.relatesTo, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code, DocumentReference.relatesTo.target, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.relatesTo.target.reference, DocumentReference.relatesTo.target.type, DocumentReference.relatesTo.target.identifier, DocumentReference.relatesTo.target.display, DocumentReference.description, DocumentReference.securityLabel, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment, DocumentReference.content.attachment.contentType, DocumentReference.content.attachment.language, DocumentReference.content.attachment.data, DocumentReference.content.attachment.url, DocumentReference.content.attachment.size, DocumentReference.content.attachment.hash, DocumentReference.content.attachment.title, DocumentReference.content.attachment.creation, DocumentReference.content.format, DocumentReference.context, DocumentReference.context.extension, DocumentReference.context.modifierExtension, DocumentReference.context.encounter, DocumentReference.context.encounter.extension, DocumentReference.context.encounter.extension:encounter, DocumentReference.context.encounter.reference, DocumentReference.context.encounter.type, DocumentReference.context.encounter.identifier, DocumentReference.context.encounter.display, DocumentReference.context.event, DocumentReference.context.period, DocumentReference.context.period.extension, DocumentReference.context.period.extension:period, DocumentReference.context.period.start, DocumentReference.context.period.end, DocumentReference.context.facilityType, DocumentReference.context.practiceSetting, DocumentReference.context.sourcePatientInfo, DocumentReference.context.sourcePatientInfo.extension, DocumentReference.context.sourcePatientInfo.extension:sourcePatientInfo, DocumentReference.context.sourcePatientInfo.reference, DocumentReference.context.sourcePatientInfo.type, DocumentReference.context.sourcePatientInfo.identifier, DocumentReference.context.sourcePatientInfo.display, DocumentReference.context.related, DocumentReference.context.related.extension, DocumentReference.context.related.extension:identifier, DocumentReference.context.related.extension:ref, DocumentReference.context.related.reference, DocumentReference.context.related.type, DocumentReference.context.related.identifier, DocumentReference.context.related.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.meta.extension, DocumentReference.meta.extension:meta, DocumentReference.text.extension, DocumentReference.text.extension:text, DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.masterIdentifier.extension, DocumentReference.masterIdentifier.extension:masterIdentifier, DocumentReference.identifier.extension, DocumentReference.identifier.extension:identifier, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.authenticator.extension, DocumentReference.authenticator.extension:authenticator, DocumentReference.custodian.extension, DocumentReference.custodian.extension:custodian, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment, DocumentReference.context.extension, DocumentReference.context.modifierExtension, DocumentReference.context.encounter.extension, DocumentReference.context.encounter.extension:encounter, DocumentReference.context.period.extension, DocumentReference.context.period.extension:period, DocumentReference.context.sourcePatientInfo.extension, DocumentReference.context.sourcePatientInfo.extension:sourcePatientInfo, DocumentReference.context.related.extension, DocumentReference.context.related.extension:identifier, DocumentReference.context.related.extension:ref Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error DocumentReference.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error DocumentReference.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.0.1) A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:created 0..1 dateTime DSTU2: Document creation time (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.created
Constraints: ext-1
.... extension:indexed 1..1 instant DSTU2: When this document reference created (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.indexed
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..* BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:attachment 1..1 Attachment DSTU2: attachment additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.content.attachment
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error DocumentReference.implicitRules, DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.status, DocumentReference.content, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.0.1) A reference to a document
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.text
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:created 0..1 dateTime DSTU2: Document creation time (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.created
.... extension:indexed 1..1 instant DSTU2: When this document reference created (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.indexed
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:masterIdentifier 0..1 Identifier DSTU2: masterIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.masterIdentifier
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.identifier
... docStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:docStatus 0..1 CodeableConcept DSTU2: preliminary | final | appended | amended | entered-in-error additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: CompositionStatus (required): Status of the underlying document.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) DSTU2: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Resource) DSTU2: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... authenticator
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:authenticator 0..1 Reference(Resource) DSTU2: authenticator additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 Reference(Resource) DSTU2: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relatesTo
.... target
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 Reference(Resource) DSTU2: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... content
.... attachment
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:attachment 0..1 Attachment DSTU2: attachment additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.content.attachment
... context
.... encounter
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:encounter 0..1 Reference(Resource) DSTU2: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.period
.... sourcePatientInfo
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:sourcePatientInfo 0..1 Reference(Resource) DSTU2: sourcePatientInfo additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... related
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:identifier 0..1 Identifier DSTU2: Identifier of related objects or events (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.related.identifier
...... extension:ref 0..1 Reference(Resource) DSTU2: Related Resource additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.0.1) A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:created 0..1 dateTime DSTU2: Document creation time (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.created
Constraints: ext-1
.... extension:indexed 1..1 instant DSTU2: When this document reference created (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.indexed
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:masterIdentifier 0..1 Identifier DSTU2: masterIdentifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.masterIdentifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... identifier Σ 0..* Identifier Other identifiers for the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:docStatus 0..1 CodeableConcept DSTU2: preliminary | final | appended | amended | entered-in-error additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: CompositionStatus (required): Status of the underlying document.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) DSTU2: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:author 0..1 Reference(Resource) DSTU2: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:authenticator 0..1 Reference(Resource) DSTU2: authenticator additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... custodian 0..1 Reference(Organization) Organization which maintains the document
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:custodian 0..1 Reference(Resource) DSTU2: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:target 0..1 Reference(Resource) DSTU2: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:attachment 1..1 Attachment DSTU2: attachment additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.content.attachment
Constraints: ext-1
..... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Data inline, base64ed
..... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:encounter 0..1 Reference(Resource) DSTU2: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:sourcePatientInfo 0..1 Reference(Resource) DSTU2: sourcePatientInfo additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... related 0..* Reference(Resource) Related identifiers or resources
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:identifier 0..1 Identifier DSTU2: Identifier of related objects or events (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-DocumentReference.context.related.identifier
Constraints: ext-1
...... extension:ref 0..1 Reference(Resource) DSTU2: Related Resource additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.text.​status Base required NarrativeStatus 📍4.0.1 FHIR Std.
DocumentReference.masterIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.masterIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.subject.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.author.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.authenticator.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.custodian.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​target.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.securityLabel Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​encounter.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.context.​event Base example v3 Code System ActCode 📍3.0.0 THO v7.1
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
DocumentReference.context.​related.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error DocumentReference.meta, DocumentReference.meta.extension, DocumentReference.meta.extension:meta, DocumentReference.meta.versionId, DocumentReference.meta.lastUpdated, DocumentReference.meta.source, DocumentReference.meta.profile, DocumentReference.meta.security, DocumentReference.meta.tag, DocumentReference.implicitRules, DocumentReference.language, DocumentReference.text, DocumentReference.text.extension, DocumentReference.text.extension:text, DocumentReference.text.status, DocumentReference.text.div, DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.masterIdentifier, DocumentReference.masterIdentifier.extension, DocumentReference.masterIdentifier.extension:masterIdentifier, DocumentReference.masterIdentifier.use, DocumentReference.masterIdentifier.type, DocumentReference.masterIdentifier.system, DocumentReference.masterIdentifier.value, DocumentReference.masterIdentifier.period, DocumentReference.masterIdentifier.assigner, DocumentReference.identifier, DocumentReference.identifier.extension, DocumentReference.identifier.extension:identifier, DocumentReference.identifier.use, DocumentReference.identifier.type, DocumentReference.identifier.system, DocumentReference.identifier.value, DocumentReference.identifier.period, DocumentReference.identifier.assigner, DocumentReference.status, DocumentReference.docStatus, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.type, DocumentReference.category, DocumentReference.subject, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.subject.reference, DocumentReference.subject.type, DocumentReference.subject.identifier, DocumentReference.subject.display, DocumentReference.date, DocumentReference.author, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.author.reference, DocumentReference.author.type, DocumentReference.author.identifier, DocumentReference.author.display, DocumentReference.authenticator, DocumentReference.authenticator.extension, DocumentReference.authenticator.extension:authenticator, DocumentReference.authenticator.reference, DocumentReference.authenticator.type, DocumentReference.authenticator.identifier, DocumentReference.authenticator.display, DocumentReference.custodian, DocumentReference.custodian.extension, DocumentReference.custodian.extension:custodian, DocumentReference.custodian.reference, DocumentReference.custodian.type, DocumentReference.custodian.identifier, DocumentReference.custodian.display, DocumentReference.relatesTo, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code, DocumentReference.relatesTo.target, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.relatesTo.target.reference, DocumentReference.relatesTo.target.type, DocumentReference.relatesTo.target.identifier, DocumentReference.relatesTo.target.display, DocumentReference.description, DocumentReference.securityLabel, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment, DocumentReference.content.attachment.contentType, DocumentReference.content.attachment.language, DocumentReference.content.attachment.data, DocumentReference.content.attachment.url, DocumentReference.content.attachment.size, DocumentReference.content.attachment.hash, DocumentReference.content.attachment.title, DocumentReference.content.attachment.creation, DocumentReference.content.format, DocumentReference.context, DocumentReference.context.extension, DocumentReference.context.modifierExtension, DocumentReference.context.encounter, DocumentReference.context.encounter.extension, DocumentReference.context.encounter.extension:encounter, DocumentReference.context.encounter.reference, DocumentReference.context.encounter.type, DocumentReference.context.encounter.identifier, DocumentReference.context.encounter.display, DocumentReference.context.event, DocumentReference.context.period, DocumentReference.context.period.extension, DocumentReference.context.period.extension:period, DocumentReference.context.period.start, DocumentReference.context.period.end, DocumentReference.context.facilityType, DocumentReference.context.practiceSetting, DocumentReference.context.sourcePatientInfo, DocumentReference.context.sourcePatientInfo.extension, DocumentReference.context.sourcePatientInfo.extension:sourcePatientInfo, DocumentReference.context.sourcePatientInfo.reference, DocumentReference.context.sourcePatientInfo.type, DocumentReference.context.sourcePatientInfo.identifier, DocumentReference.context.sourcePatientInfo.display, DocumentReference.context.related, DocumentReference.context.related.extension, DocumentReference.context.related.extension:identifier, DocumentReference.context.related.extension:ref, DocumentReference.context.related.reference, DocumentReference.context.related.type, DocumentReference.context.related.identifier, DocumentReference.context.related.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.meta.extension, DocumentReference.meta.extension:meta, DocumentReference.text.extension, DocumentReference.text.extension:text, DocumentReference.extension, DocumentReference.extension:created, DocumentReference.extension:indexed, DocumentReference.modifierExtension, DocumentReference.masterIdentifier.extension, DocumentReference.masterIdentifier.extension:masterIdentifier, DocumentReference.identifier.extension, DocumentReference.identifier.extension:identifier, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.authenticator.extension, DocumentReference.authenticator.extension:authenticator, DocumentReference.custodian.extension, DocumentReference.custodian.extension:custodian, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment.extension, DocumentReference.content.attachment.extension:attachment, DocumentReference.context.extension, DocumentReference.context.modifierExtension, DocumentReference.context.encounter.extension, DocumentReference.context.encounter.extension:encounter, DocumentReference.context.period.extension, DocumentReference.context.period.extension:period, DocumentReference.context.sourcePatientInfo.extension, DocumentReference.context.sourcePatientInfo.extension:sourcePatientInfo, DocumentReference.context.related.extension, DocumentReference.context.related.extension:identifier, DocumentReference.context.related.extension:ref Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error DocumentReference.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error DocumentReference.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron