Skip to content

DocumentReference Profile

Canonical../StructureDefinition/nexus-emr-core-documentreference
Statusdraft · 1.26.0
BaseDocumentReference (constraint)
CQL primary code pathtypewhat this means
SourceFSH · JSON

Nexus EMR profile for an ATTACHED DOCUMENT -- a clinical document that exists as a file: scanned paper, incoming faxes, external consult letters received as PDF, signed consent forms, patient-uploaded files. FHIR holds the metadata and clinical context; the bytes live in document storage and are reached through content.attachment.url.

Invariants

Every rule in force on a conforming instance. This profile rows are stated here; inherited rows come from the base resource and are listed so that a constraint named on an element is findable. Invariant keys elsewhere on this page link into this table.

Key Source Severity On Rule
attachment-has-data-or-url this profile error DocumentReference Each attachment must have either inline data (base64) or a url (blob storage URI), or both
content.all(attachment.data.exists() or attachment.url.exists())
nexus-documentreference-field-mapping-only-on-template this profile error DocumentReference A field mapping SHALL appear only on a form template (an identifier under NamingSystem/nexus-form-template): it names the fillable fields of the template's file that a chart value pre-fills, and a filed form carries the values themselves
extension.where(url = '../StructureDefinition/nexus-form-template-field-mapping').exists() implies identifier.where(system = '../NamingSystem/nexus-form-template').exists()
nexus-documentreference-subject-unless-template this profile error DocumentReference A DocumentReference SHALL carry a subject unless it is a form template. A template (an identifier under NamingSystem/nexus-form-template) is the tenant-wide blank of a form type and is about no patient; every other document is about one.
subject.exists() or identifier.where(system = '../NamingSystem/nexus-form-template').exists()
dom-2 inherited error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-3 inherited 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
dom-4 inherited 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 inherited error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
dom-6 inherited warning DocumentReference A resource should have narrative for robust management
text.div.exists()
ele-1 inherited error DocumentReference.meta All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1 inherited error DocumentReference.meta.extension Must have either extensions or value[x], not both
extension.exists() != value.exists()