Overview

This DocumentReference can be used to post an ePrescription to TRxHub.

It must reference a ServiceRequest with code register-eprescription.

After registering an ePrescription, the server will return a Bundle of MedicationRequest containing the medication from the ePrescription.

TRxHub only allows to register an ePrescription once. Once an ePrescription has been registered in TRxHub it cannot be registered again.

Author

The author is the practitioner who created the ePrescription. If omitted, the practitioner from the ePrescription will be used and created automatically.

If a manual definition of the practitioner is required, a Practitioner resource must be created first.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
DocumentReference.type.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.type.text		0..1	string	Plain text representation of the concept
DocumentReference.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
DocumentReference.type.coding.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.coding.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.type.coding.version		0..1	string	Version of the system - if relevant
DocumentReference.type.coding.userSelected		0..1	boolean	If this coding was chosen directly by the user
DocumentReference.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
DocumentReference.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 57833-6
DocumentReference.type.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	Representation defined by the system Fixed Value: Prescription for medication
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries. C	1..1	Reference(Patient)	Who/what is the subject of the document Constraints: trxhub-inv-patient-ref-only
DocumentReference.author	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(Practitioner)	Who and/or what authored the document Constraints: trxhub-inv-practitioner-ref-only
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries.	1..1	Attachment	Where to access the document
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..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. Required Pattern: text/plain
DocumentReference.content.attachment.data	S This element must be supported.	1..1	base64Binary	Data inline, base64ed
DocumentReference.context	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Clinical context of document
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.context.related	S This element must be supported. C	1..1	Reference(ServiceRequest)	Related identifiers or resources Constraints: trxhub-inv-service-request-ref-only
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.status	Base	required	DocumentReferenceStatus	📍4.0.1	FHIR Std.
DocumentReference.type	Base	preferred	Document Type Value Set	📍4.0.1	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	MimeType	📍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()
trxhub-inv-patient-ref-only	error	DocumentReference.subject	Reference must point to a Patient resource	reference.exists() implies (reference.startsWith('Patient/') or reference.startsWith('urn:uuid:'))
trxhub-inv-practitioner-ref-only	error	DocumentReference.author	Reference must point to a Practitioner resource	reference.exists() implies (reference.startsWith('Practitioner/') or reference.startsWith('urn:uuid:'))
trxhub-inv-service-request-ref-only	error	DocumentReference.context.related	Reference must point to a ServiceRequest resource	reference.exists() implies (reference.startsWith('ServiceRequest/') or reference.startsWith('urn:uuid:'))

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.status	S This element must be supported.	1..1	code	current | superseded | entered-in-error Required Pattern: current
DocumentReference.type	S This element must be supported.	1..1	CodeableConcept	Kind of document (LOINC if possible) Required Pattern: At least the following
DocumentReference.type.coding				Fixed Value: (Complex)
DocumentReference.type.coding.system	S This element must be supported.	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
DocumentReference.type.coding.code	S This element must be supported.	1..1	code	Symbol in syntax defined by the system Fixed Value: 57833-6
DocumentReference.type.coding.display	S This element must be supported.	1..1	string	Representation defined by the system Fixed Value: Prescription for medication
DocumentReference.subject	S This element must be supported. C	1..1	Reference(Patient)	Who/what is the subject of the document Constraints: trxhub-inv-patient-ref-only
DocumentReference.author	S This element must be supported. C	0..1	Reference(Practitioner)	Who and/or what authored the document Constraints: trxhub-inv-practitioner-ref-only
DocumentReference.content	S This element must be supported.	1..1	BackboneElement	Document referenced
DocumentReference.content.attachment	S This element must be supported.	1..1	Attachment	Where to access the document
DocumentReference.content.attachment.contentType	S This element must be supported.	1..1	code	Mime type of the content, with charset etc. Required Pattern: text/plain
DocumentReference.content.attachment.data	S This element must be supported.	1..1	base64Binary	Data inline, base64ed
DocumentReference.context	S This element must be supported.	1..1	BackboneElement	Clinical context of document
DocumentReference.context.related	S This element must be supported. C	1..1	Reference(ServiceRequest)	Related identifiers or resources Constraints: trxhub-inv-service-request-ref-only
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
trxhub-inv-patient-ref-only	error	DocumentReference.subject	Reference must point to a Patient resource	reference.exists() implies (reference.startsWith('Patient/') or reference.startsWith('urn:uuid:'))
trxhub-inv-practitioner-ref-only	error	DocumentReference.author	Reference must point to a Practitioner resource	reference.exists() implies (reference.startsWith('Practitioner/') or reference.startsWith('urn:uuid:'))
trxhub-inv-service-request-ref-only	error	DocumentReference.context.related	Reference must point to a ServiceRequest resource	reference.exists() implies (reference.startsWith('ServiceRequest/') or reference.startsWith('urn:uuid:'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
DocumentReference.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.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
DocumentReference.contained		0..*	Resource	Contained, inline Resources
DocumentReference.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.masterIdentifier	Σ This element is included in summaries.	0..1	Identifier	Master Version Specific Identifier
DocumentReference.identifier	Σ This element is included in summaries.	0..*	Identifier	Other identifiers for the document
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
DocumentReference.docStatus	Σ This element is included in summaries.	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
DocumentReference.type.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
DocumentReference.type.coding.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
DocumentReference.type.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
DocumentReference.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 57833-6
DocumentReference.type.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	Representation defined by the system Fixed Value: Prescription for medication
DocumentReference.type.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
DocumentReference.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
DocumentReference.category	Σ This element is included in summaries.	0..*	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries. C	1..1	Reference(Patient)	Who/what is the subject of the document Constraints: trxhub-inv-patient-ref-only
DocumentReference.date	Σ This element is included in summaries.	0..1	instant	When this document reference was created
DocumentReference.author	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(Practitioner)	Who and/or what authored the document Constraints: trxhub-inv-practitioner-ref-only
DocumentReference.authenticator		0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document
DocumentReference.custodian		0..1	Reference(Organization)	Organization which maintains the document
DocumentReference.relatesTo	Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.id		0..1	string	Unique id for inter-element referencing
DocumentReference.relatesTo.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target	Σ This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	Σ This element is included in summaries.	0..1	string	Human-readable description
DocumentReference.securityLabel	Σ This element is included in summaries.	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.id		0..1	string	Unique id for inter-element referencing
DocumentReference.content.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries.	1..1	Attachment	Where to access the document
DocumentReference.content.attachment.id		0..1	string	Unique id for inter-element referencing
DocumentReference.content.attachment.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..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. Required Pattern: text/plain
DocumentReference.content.attachment.language	Σ This element is included in summaries.	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
DocumentReference.content.attachment.data	S This element must be supported.	1..1	base64Binary	Data inline, base64ed
DocumentReference.content.attachment.url	Σ This element is included in summaries.	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size	Σ This element is included in summaries.	0..1	unsignedInt	Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash	Σ This element is included in summaries.	0..1	base64Binary	Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title	Σ This element is included in summaries.	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
DocumentReference.content.attachment.creation	Σ This element is included in summaries.	0..1	dateTime	Date attachment was first created
DocumentReference.content.format	Σ This element is included in summaries.	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Clinical context of document
DocumentReference.context.id		0..1	string	Unique id for inter-element referencing
DocumentReference.context.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter		0..*	Reference(Encounter | EpisodeOfCare)	Context of the document content
DocumentReference.context.event		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period	Σ This element is included in summaries.	0..1	Period	Time of service that is being documented
DocumentReference.context.facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.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).
DocumentReference.context.sourcePatientInfo		0..1	Reference(Patient)	Patient demographics from source
DocumentReference.context.related	S This element must be supported. C	1..1	Reference(ServiceRequest)	Related identifiers or resources Constraints: trxhub-inv-service-request-ref-only
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	example	Document Class Value Set	📍4.0.1	FHIR Std.
DocumentReference.relatesTo.​code	Base	required	DocumentRelationshipType	📍4.0.1	FHIR Std.
DocumentReference.securityLabel	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
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.​event	Base	example	v3 Code System ActCode	📦3.0.0	THO v7.4
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()
trxhub-inv-patient-ref-only	error	DocumentReference.subject	Reference must point to a Patient resource	reference.exists() implies (reference.startsWith('Patient/') or reference.startsWith('urn:uuid:'))
trxhub-inv-practitioner-ref-only	error	DocumentReference.author	Reference must point to a Practitioner resource	reference.exists() implies (reference.startsWith('Practitioner/') or reference.startsWith('urn:uuid:'))
trxhub-inv-service-request-ref-only	error	DocumentReference.context.related	Reference must point to a ServiceRequest resource	reference.exists() implies (reference.startsWith('ServiceRequest/') or reference.startsWith('urn:uuid:'))

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
DocumentReference.type.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.type.text		0..1	string	Plain text representation of the concept
DocumentReference.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
DocumentReference.type.coding.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.coding.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.type.coding.version		0..1	string	Version of the system - if relevant
DocumentReference.type.coding.userSelected		0..1	boolean	If this coding was chosen directly by the user
DocumentReference.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
DocumentReference.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 57833-6
DocumentReference.type.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	Representation defined by the system Fixed Value: Prescription for medication
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries. C	1..1	Reference(Patient)	Who/what is the subject of the document Constraints: trxhub-inv-patient-ref-only
DocumentReference.author	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(Practitioner)	Who and/or what authored the document Constraints: trxhub-inv-practitioner-ref-only
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries.	1..1	Attachment	Where to access the document
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..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. Required Pattern: text/plain
DocumentReference.content.attachment.data	S This element must be supported.	1..1	base64Binary	Data inline, base64ed
DocumentReference.context	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Clinical context of document
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.context.related	S This element must be supported. C	1..1	Reference(ServiceRequest)	Related identifiers or resources Constraints: trxhub-inv-service-request-ref-only
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.status	Base	required	DocumentReferenceStatus	📍4.0.1	FHIR Std.
DocumentReference.type	Base	preferred	Document Type Value Set	📍4.0.1	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	MimeType	📍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()
trxhub-inv-patient-ref-only	error	DocumentReference.subject	Reference must point to a Patient resource	reference.exists() implies (reference.startsWith('Patient/') or reference.startsWith('urn:uuid:'))
trxhub-inv-practitioner-ref-only	error	DocumentReference.author	Reference must point to a Practitioner resource	reference.exists() implies (reference.startsWith('Practitioner/') or reference.startsWith('urn:uuid:'))
trxhub-inv-service-request-ref-only	error	DocumentReference.context.related	Reference must point to a ServiceRequest resource	reference.exists() implies (reference.startsWith('ServiceRequest/') or reference.startsWith('urn:uuid:'))

Differential View

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.status	S This element must be supported.	1..1	code	current | superseded | entered-in-error Required Pattern: current
DocumentReference.type	S This element must be supported.	1..1	CodeableConcept	Kind of document (LOINC if possible) Required Pattern: At least the following
DocumentReference.type.coding				Fixed Value: (Complex)
DocumentReference.type.coding.system	S This element must be supported.	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
DocumentReference.type.coding.code	S This element must be supported.	1..1	code	Symbol in syntax defined by the system Fixed Value: 57833-6
DocumentReference.type.coding.display	S This element must be supported.	1..1	string	Representation defined by the system Fixed Value: Prescription for medication
DocumentReference.subject	S This element must be supported. C	1..1	Reference(Patient)	Who/what is the subject of the document Constraints: trxhub-inv-patient-ref-only
DocumentReference.author	S This element must be supported. C	0..1	Reference(Practitioner)	Who and/or what authored the document Constraints: trxhub-inv-practitioner-ref-only
DocumentReference.content	S This element must be supported.	1..1	BackboneElement	Document referenced
DocumentReference.content.attachment	S This element must be supported.	1..1	Attachment	Where to access the document
DocumentReference.content.attachment.contentType	S This element must be supported.	1..1	code	Mime type of the content, with charset etc. Required Pattern: text/plain
DocumentReference.content.attachment.data	S This element must be supported.	1..1	base64Binary	Data inline, base64ed
DocumentReference.context	S This element must be supported.	1..1	BackboneElement	Clinical context of document
DocumentReference.context.related	S This element must be supported. C	1..1	Reference(ServiceRequest)	Related identifiers or resources Constraints: trxhub-inv-service-request-ref-only
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
trxhub-inv-patient-ref-only	error	DocumentReference.subject	Reference must point to a Patient resource	reference.exists() implies (reference.startsWith('Patient/') or reference.startsWith('urn:uuid:'))
trxhub-inv-practitioner-ref-only	error	DocumentReference.author	Reference must point to a Practitioner resource	reference.exists() implies (reference.startsWith('Practitioner/') or reference.startsWith('urn:uuid:'))
trxhub-inv-service-request-ref-only	error	DocumentReference.context.related	Reference must point to a ServiceRequest resource	reference.exists() implies (reference.startsWith('ServiceRequest/') or reference.startsWith('urn:uuid:'))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
DocumentReference.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
DocumentReference.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.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
DocumentReference.contained		0..*	Resource	Contained, inline Resources
DocumentReference.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.masterIdentifier	Σ This element is included in summaries.	0..1	Identifier	Master Version Specific Identifier
DocumentReference.identifier	Σ This element is included in summaries.	0..*	Identifier	Other identifiers for the document
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
DocumentReference.docStatus	Σ This element is included in summaries.	0..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
DocumentReference.type.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.type.coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
DocumentReference.type.coding.id		0..1	string	Unique id for inter-element referencing
DocumentReference.type.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.type.coding.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://loinc.org
DocumentReference.type.coding.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
DocumentReference.type.coding.code	S This element must be supported. Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system Fixed Value: 57833-6
DocumentReference.type.coding.display	S This element must be supported. Σ This element is included in summaries.	1..1	string	Representation defined by the system Fixed Value: Prescription for medication
DocumentReference.type.coding.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
DocumentReference.type.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
DocumentReference.category	Σ This element is included in summaries.	0..*	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries. C	1..1	Reference(Patient)	Who/what is the subject of the document Constraints: trxhub-inv-patient-ref-only
DocumentReference.date	Σ This element is included in summaries.	0..1	instant	When this document reference was created
DocumentReference.author	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(Practitioner)	Who and/or what authored the document Constraints: trxhub-inv-practitioner-ref-only
DocumentReference.authenticator		0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document
DocumentReference.custodian		0..1	Reference(Organization)	Organization which maintains the document
DocumentReference.relatesTo	Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.id		0..1	string	Unique id for inter-element referencing
DocumentReference.relatesTo.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target	Σ This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	Σ This element is included in summaries.	0..1	string	Human-readable description
DocumentReference.securityLabel	Σ This element is included in summaries.	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.id		0..1	string	Unique id for inter-element referencing
DocumentReference.content.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries.	1..1	Attachment	Where to access the document
DocumentReference.content.attachment.id		0..1	string	Unique id for inter-element referencing
DocumentReference.content.attachment.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..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. Required Pattern: text/plain
DocumentReference.content.attachment.language	Σ This element is included in summaries.	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
DocumentReference.content.attachment.data	S This element must be supported.	1..1	base64Binary	Data inline, base64ed
DocumentReference.content.attachment.url	Σ This element is included in summaries.	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size	Σ This element is included in summaries.	0..1	unsignedInt	Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash	Σ This element is included in summaries.	0..1	base64Binary	Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title	Σ This element is included in summaries.	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
DocumentReference.content.attachment.creation	Σ This element is included in summaries.	0..1	dateTime	Date attachment was first created
DocumentReference.content.format	Σ This element is included in summaries.	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
DocumentReference.context	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Clinical context of document
DocumentReference.context.id		0..1	string	Unique id for inter-element referencing
DocumentReference.context.extension		0..*	Extension	Additional content defined by implementations
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter		0..*	Reference(Encounter | EpisodeOfCare)	Context of the document content
DocumentReference.context.event		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period	Σ This element is included in summaries.	0..1	Period	Time of service that is being documented
DocumentReference.context.facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.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).
DocumentReference.context.sourcePatientInfo		0..1	Reference(Patient)	Patient demographics from source
DocumentReference.context.related	S This element must be supported. C	1..1	Reference(ServiceRequest)	Related identifiers or resources Constraints: trxhub-inv-service-request-ref-only
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	example	Document Class Value Set	📍4.0.1	FHIR Std.
DocumentReference.relatesTo.​code	Base	required	DocumentRelationshipType	📍4.0.1	FHIR Std.
DocumentReference.securityLabel	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
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.​event	Base	example	v3 Code System ActCode	📦3.0.0	THO v7.4
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()
trxhub-inv-patient-ref-only	error	DocumentReference.subject	Reference must point to a Patient resource	reference.exists() implies (reference.startsWith('Patient/') or reference.startsWith('urn:uuid:'))
trxhub-inv-practitioner-ref-only	error	DocumentReference.author	Reference must point to a Practitioner resource	reference.exists() implies (reference.startsWith('Practitioner/') or reference.startsWith('urn:uuid:'))
trxhub-inv-service-request-ref-only	error	DocumentReference.context.related	Reference must point to a ServiceRequest resource	reference.exists() implies (reference.startsWith('ServiceRequest/') or reference.startsWith('urn:uuid:'))

This structure is derived from DocumentReference

Summary

Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 13 elements