DocumentReference Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-documentreference |
|---|---|
| Status | draft · 1.26.0 |
| Base | DocumentReference (constraint) |
| CQL primary code path | type — what this means |
| Source | FSH · 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.
TypedFhir API / Python
The typed accessor surface DocumentReference exposes for DocumentReference — generated from this IG's compiled profile; each typed accessor has a validating raw-FHIR twin (xRaw) where marked. The three ports are parity-enforced.
class DocumentReference(ClinicalResource) — generated source
| Accessor | Type | Access | Notes |
|---|---|---|---|
| effective_date | FuzzyDate | None |
read-only | The resource's effective date — the first present of this profile's date elements (precedence), normalized to the canonical FuzzyDatetime f… |
| display | str | None |
read-only | The resource's human headline — a coded concept's label, else a title / name, else undefined. |
| status | str | None |
read/write | Where the document reference is in its lifecycle |
| doc_status | str | None |
read/write | preliminary | final | amended | entered-in-error |
| type | Concept | None |
read/write · raw twin | Precise type of document (use category instead) |
| category | Concepts |
read/write · raw twin | Document categorization (preferred over type) |
| subject | Reference | None |
read/write · raw twin | The patient the document is about |
| date | FuzzyDate | None |
read/write | When DocumentReference was created (not document date) |
| author | References |
read/write · raw twin | Who wrote the document |
| authenticator | Reference | None |
read/write · raw twin | Practitioner who verified this document |
| custodian | Reference | None |
read/write · raw twin | Organization responsible for document maintenance |
| description | str | None |
read/write | Human-readable description of document content |
| security_label | Concepts |
read/write · raw twin | Document security-tags |
| content | dict[] | None |
read/write | Document attachment(s) -- submitted inline, stored as files, read back by URL |