DRAFT PH Road Safety Implementation Guide
0.1.0 - ci-build Philippines flag

DRAFT PH Road Safety Implementation Guide, published by UP Manila - National Institutes of Health - National Telehealth Center. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UPM-NTHC/PH-RoadSafetyIG/ and changes regularly. See the Directory of published versions

Resource Profile: Road Safety Document Reference

Official URL: https://build.fhir.org/ig/UPM-NTHC/PH-RoadSafetyIG/StructureDefinition/RS-Documentreference Version: 0.1.0
Draft as of 2025-10-08 Computable Name: RSDocumentReference

A profile to capture documents related to road safety incidents in the Philippine context.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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 A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: appends
.... target Σ 1..1 Reference(DocumentReference) Reference to documentation of traffic incident management.
... Slices for content Σ 1..* BackboneElement Document referenced
Slice: Unordered, Open by pattern:attachment.contentType
.... content:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
.... content:roadNetworkFile SΣ 0..1 BackboneElement Document referenced
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Road Network File Type (required)
Example General: text/plain; charset=UTF-8, image/png
...... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... title Σ 0..1 string Detailed road network shape file
Example General: Official Corporate Logo
.... content:causeOfCrashFile SΣ 0..1 BackboneElement Document referenced
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Cause of Crash File Type ValueSet (required)
Example General: text/plain; charset=UTF-8, image/png
...... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... title Σ 0..1 string Document file describing cause of road crash
Example General: Official Corporate Logo
... context Σ 0..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 1..1 Reference(Road Safety Encounter) Context of the document content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.category Base required Report Form Received 📦0.1.0 This IG
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.content:roadNetworkFile.​attachment.contentType Base required Road Network File Type 📦0.1.0 This IG
DocumentReference.content:causeOfCrashFile.​attachment.contentType Base required Cause of Crash File Type ValueSet 📦0.1.0 This IG

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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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 A reference to a document
... status S 1..1 code current | superseded | entered-in-error
... category 1..1 CodeableConcept Categorization of document
Binding: Report Form Received (required)
... relatesTo S 0..* BackboneElement Relationships to other documents
.... code 1..1 code replaces | transforms | signs | appends
Fixed Value: appends
.... target 1..1 Reference(DocumentReference) Reference to documentation of traffic incident management.
.... content:roadNetworkFile S 0..1 BackboneElement Document referenced
..... attachment
...... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: Road Network File Type (required)
...... url S 0..1 url Uri where the data can be found
...... title 0..1 string Detailed road network shape file
.... content:causeOfCrashFile S 0..1 BackboneElement Document referenced
..... attachment
...... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: Cause of Crash File Type ValueSet (required)
...... url S 0..1 url Uri where the data can be found
...... title 0..1 string Document file describing cause of road crash
... context
.... encounter S 1..1 Reference(Road Safety Encounter) Context of the document content

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.category Base required Report Form Received 📦0.1.0 This IG
DocumentReference.content:roadNetworkFile.​attachment.contentType Base required Road Network File Type 📦0.1.0 This IG
DocumentReference.content:causeOfCrashFile.​attachment.contentType Base required Cause of Crash File Type ValueSet 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣ 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.
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
... category Σ 1..1 CodeableConcept Categorization of document
Binding: Report Form Received (required)
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
... 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
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: appends
.... target Σ 1..1 Reference(DocumentReference) Reference to documentation of traffic incident management.
... 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.
... Slices for content Σ 1..* BackboneElement Document referenced
Slice: Unordered, Open by pattern:attachment.contentType
.... content:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
..... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
.... content:roadNetworkFile SΣ 0..1 BackboneElement Document referenced
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Road Network File Type (required)
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 SΣ 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 Detailed road network shape file
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.
.... content:causeOfCrashFile SΣ 0..1 BackboneElement Document referenced
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Cause of Crash File Type ValueSet (required)
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 SΣ 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 Document file describing cause of road crash
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 1..1 Reference(Road Safety Encounter) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... 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
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍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 required Report Form Received 📦0.1.0 This IG
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.content:roadNetworkFile.​attachment.contentType Base required Road Network File Type 📦0.1.0 This IG
DocumentReference.content:roadNetworkFile.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content:roadNetworkFile.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.content:causeOfCrashFile.​attachment.contentType Base required Cause of Crash File Type ValueSet 📦0.1.0 This IG
DocumentReference.content:causeOfCrashFile.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content:causeOfCrashFile.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
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.

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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.content

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: appends
.... target Σ 1..1 Reference(DocumentReference) Reference to documentation of traffic incident management.
... Slices for content Σ 1..* BackboneElement Document referenced
Slice: Unordered, Open by pattern:attachment.contentType
.... content:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
.... content:roadNetworkFile SΣ 0..1 BackboneElement Document referenced
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Road Network File Type (required)
Example General: text/plain; charset=UTF-8, image/png
...... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... title Σ 0..1 string Detailed road network shape file
Example General: Official Corporate Logo
.... content:causeOfCrashFile SΣ 0..1 BackboneElement Document referenced
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Cause of Crash File Type ValueSet (required)
Example General: text/plain; charset=UTF-8, image/png
...... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... title Σ 0..1 string Document file describing cause of road crash
Example General: Official Corporate Logo
... context Σ 0..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 1..1 Reference(Road Safety Encounter) Context of the document content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.category Base required Report Form Received 📦0.1.0 This IG
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.content:roadNetworkFile.​attachment.contentType Base required Road Network File Type 📦0.1.0 This IG
DocumentReference.content:causeOfCrashFile.​attachment.contentType Base required Cause of Crash File Type ValueSet 📦0.1.0 This IG

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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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 A reference to a document
... status S 1..1 code current | superseded | entered-in-error
... category 1..1 CodeableConcept Categorization of document
Binding: Report Form Received (required)
... relatesTo S 0..* BackboneElement Relationships to other documents
.... code 1..1 code replaces | transforms | signs | appends
Fixed Value: appends
.... target 1..1 Reference(DocumentReference) Reference to documentation of traffic incident management.
.... content:roadNetworkFile S 0..1 BackboneElement Document referenced
..... attachment
...... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: Road Network File Type (required)
...... url S 0..1 url Uri where the data can be found
...... title 0..1 string Detailed road network shape file
.... content:causeOfCrashFile S 0..1 BackboneElement Document referenced
..... attachment
...... contentType S 1..1 code Mime type of the content, with charset etc.
Binding: Cause of Crash File Type ValueSet (required)
...... url S 0..1 url Uri where the data can be found
...... title 0..1 string Document file describing cause of road crash
... context
.... encounter S 1..1 Reference(Road Safety Encounter) Context of the document content

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.category Base required Report Form Received 📦0.1.0 This IG
DocumentReference.content:roadNetworkFile.​attachment.contentType Base required Road Network File Type 📦0.1.0 This IG
DocumentReference.content:causeOfCrashFile.​attachment.contentType Base required Cause of Crash File Type ValueSet 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!SΣ 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.
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
... category Σ 1..1 CodeableConcept Categorization of document
Binding: Report Form Received (required)
... subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
... 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
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Fixed Value: appends
.... target Σ 1..1 Reference(DocumentReference) Reference to documentation of traffic incident management.
... 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.
... Slices for content Σ 1..* BackboneElement Document referenced
Slice: Unordered, Open by pattern:attachment.contentType
.... content:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
..... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
.... content:roadNetworkFile SΣ 0..1 BackboneElement Document referenced
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Road Network File Type (required)
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 SΣ 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 Detailed road network shape file
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.
.... content:causeOfCrashFile SΣ 0..1 BackboneElement Document referenced
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... attachment Σ 1..1 Attachment Where to access the document
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Cause of Crash File Type ValueSet (required)
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 SΣ 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 Document file describing cause of road crash
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter S 1..1 Reference(Road Safety Encounter) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time of service that is being documented
.... 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
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍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 required Report Form Received 📦0.1.0 This IG
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.content:roadNetworkFile.​attachment.contentType Base required Road Network File Type 📦0.1.0 This IG
DocumentReference.content:roadNetworkFile.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content:roadNetworkFile.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.content:causeOfCrashFile.​attachment.contentType Base required Cause of Crash File Type ValueSet 📦0.1.0 This IG
DocumentReference.content:causeOfCrashFile.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content:causeOfCrashFile.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
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.

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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 9 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.content

 

Other representations of profile: CSV, Excel, Schematron