Artifacts¶
All conformance artifacts in Nexus IG 1.25.1.
Profiles (52)¶
| Name | Description |
|---|---|
| AllergyIntolerance Profile | Defines the Nexus EMR standard for AllergyIntolerance resources, based on CA-Core+. Includes instance-specific Nexus EMR identifiers, references via identifier (CII E01). |
| App Consent Profile | Simple app consent profile: Patient X consented/refused to share information with Application Y (represented as a Device). This profile models consent for a patient to sign up wit… |
| App Device Profile | Simple profile for applications that integrate with patient data and require consent tracking. Contains just the essential information: app name, client_id, and basic details. |
| App State Profile | A profile for representing external application state in Nexus EMR. |
| Appointment Profile | Minimal Nexus EMR profile for Appointment resources, primarily for mapping status, start date (Last Visit Date), and required patient/practitioner participants. Assumes filtering … |
| Attachment Packet Profile | An attachment packet: the ordered set of chart items assembled to travel with an outbound |
| AuditEvent Profile | Nexus EMR profile for AuditEvent -- the access and activity log: who acted, on which record, when, |
| Care Plan Profile | Nexus EMR profile for CarePlan -- the management plan tying goals, conditions and activities together (CDM flowsheets, care gaps). First pass: status/intent, category, goal/addres… |
| CareTeam Profile | Nexus EMR profile for CareTeam, capturing the care providers associated with a patient (e.g. most-responsible physician, nurse, midwife, referring physician). Backs the Patient Pr… |
| ClinicalImpression Profile | Nexus EMR profile for ClinicalImpression capturing the Assessment section of a SOAP encounter note. Purpose: export assessment text. Should be exported by EMRs that have the abili… |
| Communication Profile | Nexus EMR profile for Communication, covering two distinct populations: WELL-internal staff chat about a patient, and eReferral correspondence passed through from or to external p… |
| Composition Profile | Nexus EMR profile for an AUTHORED clinical note -- principally the encounter note (progress |
| Condition Profile | Nexus EMR profile for Condition resource, representing health concerns (CII E11) or clinical assessments (CII E34). Constrains necessary elements, requires a Nexus EMR identifier,… |
| Coverage Profile | Nexus EMR profile for Coverage -- the payor context for billing and the demo dataset. First pass: the Ontario-GP shape (public plan keyed by the patient's health-card number, payo… |
| DetectedIssue Profile | Nexus EMR profile for DetectedIssue -- drug-drug and drug-allergy interaction findings raised during prescribing, and the prescriber's recorded override of them. First pass: model… |
| Device Profile | Represents an EMR software application/product, capturing key details like manufacturer, product name/model, type, version, and the owning organization using standard Nexus EMR re… |
| DiagnosticReport Profile | Defines the Nexus EMR FHIR profile for DiagnosticReport resources, based on CA-Core constraints, for aggregating diagnostic reports (e.g., Lab, Imaging) from multiple EMRs. |
| DocumentReference Profile | Nexus EMR profile for an ATTACHED DOCUMENT -- a clinical document that exists as a file: |
| Encounter Profile | Defines the Encounter resource constraints for the Nexus EMR project (CII), conforming to CA-Core+ requirements. |
| Family Member History Profile | Nexus EMR profile for FamilyMemberHistory -- family history as discrete chart content for summaries and extraction output. First pass: one relative, coded relationship, condition … |
| Flag Profile | Nexus EMR profile for Flag, carrying a singleton administrative free-text field about a patient (booking alert or patient note). The patient-flag-type coding discriminates the fie… |
| Goal Profile | Nexus EMR profile for Goal -- the measurable target behind CDM flowsheets and care gaps. First pass: lifecycle, description, target (measure/detail/due), addresses. Closed to SMAR… |
| Immunization Profile | Nexus EMR profile for Immunization resources, aligned with CA-Core+ and CII requirements. Records details about vaccines administered to a patient. |
| Invoice Profile | Nexus EMR profile for Invoice representing Canadian provider-side billing records. Aligned with Oscar Pro's existing InvoiceConverter emission (header on billing_on_cheader1, … |
| Nexus EMR Item Consent Profile Core | Patient-level consent for one consent item — one of the things a clinic needs a yes or a no on |
| Location Profile | Generic Nexus EMR core profile for Location, represents an EMR 'location' or 'site' -- |
| Medication Dispense Profile | Nexus EMR profile for MedicationDispense resources, primarily for recording dispense events. Aligns with CII N1/N2 requirements and Nexus EMR standards. |
| Medication Statement Profile | Nexus EMR profile for MedicationStatement -- patient-reported medication use, distinct from prescriptions. First pass: status, text-first medication concept, effective timing, fre… |
| MedicationRequest Profile | Defines the Nexus EMR FHIR profile for MedicationRequest resources, based on CA-Core constraints, for aggregating prescription data from multiple EMRs. |
| MessageHeader Profile | Nexus EMR profile for MessageHeader -- the routing envelope on an eReferral message bundle, consumed by the gateway's operation-routing middleware. Infrastructure rather than clin… |
| Observation Profile | Nexus EMR profile for the Observation resource, based on CA-Core. Represents measurements, tests, and simple assertions originating from source EMRs for aggregation. |
| Organization Profile | Generic Nexus EMR core profile for Organization, based on CA Core+. Designed to support a broad range of integration needs. |
| Patient Profile | Generic Nexus EMR core profile for patient demographic and administrative information, based on CA Core+. Designed to support a broad range of integration needs. |
| Practitioner Profile | Represents a human that practices medicine -- the stable clinical identity that an EMR user login resolves to. |
| PractitionerRole Profile | Represents a practitioner's role at an organization/location -- the tenant-scoped access/role binding |
| Privacy Directive Profile | A patient's standing restriction on the collection, use or disclosure of their own personal |
| Procedure Profile | Defines the Nexus EMR FHIR profile for Procedure resources, based on CA-Core Procedure constraints, for aggregating data from multiple EMRs. |
| Provenance Profile | Attribution for AI-mediated and cross-boundary writes: what was produced, when, by which agent (human or non-human), from what inputs, and -- for generated text -- which verbatim … |
| Questionnaire Profile | A Nexus EMR form definition: what it asks, what it produces, and where its answers land in the |
| QuestionnaireResponse Profile | Nexus EMR profile for QuestionnaireResponse -- completed intake, screening and consent forms, including those passed through from external eReferral partners. Appears in the patie… |
| Referral Profile | Defines the Nexus EMR FHIR profile for referrals: a request that another clinician or service accept the patient, for consultation, second opinion, or ongoing management. Aligned … |
| RelatedPerson Profile | Nexus EMR profile for RelatedPerson, capturing an alternative contact for a patient — a person the practice can reach on the patient's behalf, with a personal relationship, any nu… |
| Risk Assessment Profile | Nexus EMR profile for RiskAssessment -- computed clinical risk scores. First pass: status, method, predictions (outcome + probability + qualitative band), basis. Closed to SMART a… |
| Schedule Profile | Minimal Nexus EMR profile for Schedule resources, representing a clinic or provider's bookable calendar. Slots reference back to a Schedule via Slot.schedule. Phase 1 sources Osca… |
| ServiceRequest Profile | Defines the Nexus EMR FHIR profile for ORDER-shaped ServiceRequest resources -- laboratory, diagnostic-imaging and procedure orders -- aggregated from multiple EMRs. Referrals are… |
| Slot Profile | Minimal Nexus EMR profile for Slot resources — an individual bookable time window owned by a Schedule. Slots are materialised from recurring templates (Phase 1: OscarPro `schedule… |
| Specimen Profile | Nexus EMR profile for Specimen -- the physical sample a lab result was produced from. Currently a pass-through type: the platform resolves ServiceRequest.specimen references and t… |
| Statement of Disagreement Profile | The individual's own statement about information they asked to have corrected and the custodian |
| Subscription Profile | Nexus EMR profile for Subscription (R4 criteria-based) -- server-side push notification registration managed by the subscription manager service. Infrastructure and a data-egress … |
| Task Profile | A unit of work in the chart: who asked for it, who owns it now, what has been said about it, and |
| Task Note (one conversation turn) | One turn in a task's conversation: who said it, when, and what they said. Both people and machine actors (harness graphs, decision-support rules) author turns. Because R4 does not… |
| Template Profile | A reusable template: a List that names and identifies the template, carrying the resources it |
Extensions (42)¶
| Name | Description |
|---|---|
| App State Boolean Value Extension | A simple extension to hold the value of a Nexus EMR application-state entry as a boolean. |
| App State String Value Extension | A simple extension to hold the value of a Nexus EMR application-state entry as a string. |
| Appointment Created By Extension | The agent that created the appointment record (createdBy): authoring practitioner/user (Practitioner, or PractitionerRole where the role binding matters), system/integration (Devi… |
| Appointment Modality Extension | Delivery channel of an appointment/encounter (in-person |
| Attributed Fact | One factual statement in a piece of AI-generated text, together with the citation(s) |
| Composition Billing Extension | The billing raised for the visit this note documents: the service code, the diagnostic codes |
| Composition Block Data Extension | One section's structured value, for a render kind whose value is more than the narrative |
| Composition Block Type Extension | How to render this section -- the section's RENDER KIND, not the tool that produced it. |
| Composition EHR Share Extension | One completed share of this signed note to an EHR outside the practice. Repeats: a note shared three |
| Consent Status Reason Extension | Optional free-text reason recorded when a consent status changes, typically on revocation (Provided to Declined). Never required — a status change with no reason is normal. |
| Contact Note Extension | A free-text note about an alternative contact. |
| Contact Point Phone Extension | A phone number's extension digits. |
| Contact Primary Extension | The primary (call-first) alternative contact; at most one per patient. |
| Corrected By Extension | Points from a record known to be incorrect to the record that carries the corrected information. |
| Criteria Elements Read | One element path that this module definition's criteria logic reads, relative to the resource retrieved. Repeats, once per distinct path. Finer-grained than dataRequirement, whi… |
| Criteria Relative Date | Whether this module definition's membership can change through the passage of time alone. True means the criteria are anchored to a moving reference point ("no visit in the last s… |
| Document Status Reason Extension | Optional free-text reason recorded when a DocumentReference is marked superseded or entered in error. Never required — a status change with no reason is normal, and an active docu… |
| Effective Date | Which element carries THE effective date for this profile, as a precedence-ordered list of raw-FHIR paths -- or an explicit declaration that the profile has none. One date concept… |
| First Nation Community Extension | The First Nation community the patient affiliates with, as stated — drawn from the same curated band list as the registry group but independent of it and of the registration statu… |
| First Nation Registry Group Extension | The First Nation registry group (band) the patient's Indian Act registration is held under, as stated. Bound REQUIRED to the curated band list: a band the list does not carry cann… |
| Form Template Field Mapping | Which fillable fields of a form template's file a chart value pre-fills. One rule per field: |
| Harness Thread Id | The AI-harness thread identifier that produced or owns this Task. An opaque string for traceback from a chart artifact into harness logs; never rendered in the UI. Assigning a Tas… |
| Imaging Modality Extension | The acquisition modality this imaging report came from -- DX, US, CT, MR, MG. |
| Indian Act Registration Status Extension | Whether the patient states they are registered under the Indian Act. Records what the patient or their documentation states; the register itself is never consulted. Independent of… |
| Indian Status Card Type Extension | Which form of Indian status documentation the patient presented (SCIS, CIS, or TCRD). Rides on the Indian registration number identifier — the same idiom as a health card's versio… |
| Invoice Service Location Extension | Reference to the NexusEmrCoreLocation where the billed service was delivered. Resolves Oscar's billing_on_cheader1.location (Service Location Indicator) to a typed Location resour… |
| Measurement Rationale | Why this measurement definition exists: the specific ambiguity or unit trap it prevents. Required on every definition, because a definition that cannot name the failure it prevent… |
| Medication Strength Extension | Extension to capture medication strength information when using medicationCodeableConcept |
| Meta Updated By Extension | The user account that last wrote this version of the resource. |
| Oscar Billing Status Extension | Raw Oscar Pro billing status code (H |
| Packet Entry Excluded Page Extension | A page of this packet member that the assembler excluded from the outbound render. Repeats: one occurrence per excluded page, 1-based, counting pages of the member's rendered form… |
| Patient Record Inactive Reason Extension | Why a retired record is inactive (e.g. moved, transferred, duplicate record). |
| Prevention Status Extension | The Nexus EMR Preventions product status for a screening or other prevention Observation. |
| Primary Care Attachment | A patient's current formal primary-care roster/enrollment/attachment. Distinct from |
| Record Severed Extension | Marks a record as SEVERED: retained and traceable, but removed from ordinary clinical view |
| Resource Note Extension | An attributed note recorded on a resource with no note element of its own, such as the comment thread on a DocumentReference. Each repeat is one note in the Task Note turn shape… |
| Reviewed | Review acknowledgement state for the artifact it is stamped on -- a result or an attached document: who reviewed it and when. ABSENT means unreviewed. The Task inbox is the option… |
| Salient Field | One salient synthesized accessor on a profile: a named, typed FHIRPath value expression over the resource. Drives the reader/render surface (the AI chart) and the facade's salient… |
| Shadow Bill Extension | True when the Invoice represents a shadow bill (capitated FHO/FHN submission) rather than a regular FFS claim. Derived from Oscar billing status H (Capitated). |
| SMART Exposed | Declares that this profile's resource type is reachable by a SMART on FHIR app, and names the platform permission required for each operation. Exposure is an authorization decisio… |
| Task Priority Detail | A priority refinement finer than R4's request-priority vocabulary allows, currently one concept: trivial, meaning below routine. Task.priority binds required to a value set wh… |
| Tenant Id (platform infrastructure) | The platform tenant that owns this resource, stamped by the FHIR Gateway. PRIVATE INFRASTRUCTURE: it is not client-writable, the value is an opaque platform tenant id that resolve… |
Value sets (54)¶
| Name | Description |
|---|---|
| Appointment Modality Value Set | Delivery channel of an appointment. Extensible — a pan-Canadian / Ontario standard code may be added as a parallel coding when the provincial IG defines one. |
| Canadian Classification of Health Interventions (CCI) -- all codes | The Canadian Classification of Health Interventions (CCI) -- the Canadian classification of |
| Canadian Clinical Drug Data Set (CCDD) -- all codes | The Canadian Clinical Drug Data Set (CCDD) -- the pan-Canadian terminology for identifying and |
| Canadian Provincial Health Number Systems | Naming systems for provincial and territorial health numbers across Canada, based on Infoway standards |
| Clinical Roles | Curated clinical roles bound (extensible) to PractitionerRole.code. Extensible: instances may add local roles not in this default set. |
| Clinical Task Intent Value Set | The intents a Nexus EMR clinical task may carry: order for work already authorized and assigned, proposal for something that takes effect only once a human accepts it, and `op… |
| Clinical Task Statuses | The lifecycle states a Nexus clinical task may be in: draft, ready, accepted, in-progress, |
| Composition Classification Value Set | What kind of document a Composition is, at the coarsest useful level: an authored note, a generated |
| Composition Kind Value Set | Which kind of note, or which kind of summary, for Composition.category. |
| Composition Section Value Set | What one section of a document clinically is -- for Composition.section.code. |
| Consent Families Value Set | The Consent families this guide defines. Bound required from the family slice of |
| Nexus EMR Consent Items | The governed consent items that can be recorded for a patient. Bound from |
| Consent Override Grounds Value Set | The reason a user gave when breaking the glass, from HL7 v3 ActReason PurposeOfUse. Carried on the |
| Contact Purpose Value Set | The purpose an alternative contact serves for a patient (e.g. emergency, substitute decision maker, next of kin). |
| Correction Business Status Value Set | Where a correction or disagreement request has reached, from HL7's Patient Request for |
| Correction Task Types Value Set | HL7 Patient Request for Corrections task types, carried as an optional additional coding on |
| Data absent reason -- all codes | Data absent reason -- FHIR's own vocabulary for why a value is missing: unknown, |
| Disclosure Completeness Labels Value Set | The label a disclosure carries when a privacy directive suppressed part of what would otherwise |
| Disclosure Control Labels Value Set | Security labels this guide gives operational meaning on Resource.meta.security: markers that |
| Document Categories | The categories a user can file an uploaded document under -- the document |
| DPD active-ingredient group code (AIGC) -- all codes | The Health Canada Drug Product Database active-ingredient group CODE (AIGC) -- five digits, |
| DPD active-ingredient group number (AIGN) -- all codes | The Health Canada Drug Product Database active-ingredient group NUMBER (AIGN) -- a ten-digit |
| Drug Identification Number (DIN) -- all codes | Drug Identification Numbers (DINs) -- the eight-digit number Health Canada assigns to each drug |
| First Nation Bands | Federal band numbers and names, for coding a patient's First Nation registry group or community |
| Form Chart Values | Every chart value a form template's field mapping may draw from a patient's chart. Bound extensible: a deployment may carry a key this set does not list yet, and a reader that doe… |
| Gender Identity Value Set | Gender identity concepts offered by Nexus EMR: the three concepts bound by the HL7 gender-identity value set plus the pan-Canadian (Canada Health Infoway namespace) SNOMED CT conc… |
| HL7 identifier type codes (v2-0203) -- all codes | HL7 identifier type codes -- the vocabulary on Identifier.type that says what KIND of identifier |
| HL7 NullFlavor codes -- all codes | HL7 NullFlavor codes -- the vocabulary for saying WHY a value is missing rather than leaving it |
| ICD-10-CA -- all codes | ICD-10-CA -- the Canadian enhancement of the World Health Organization's ICD-10 classification of |
| Indian Act Registration Status | Answers to whether the patient is registered under the Indian Act. As with the sociodemographic self-identification fields, the not-answered concepts (Do not know, Asked But Decli… |
| Indian Status Card Type | The forms of Indian status documentation a patient may present. |
| Indigenous Identity Value Set | Self-identified Indigenous identity answers offered by Nexus EMR — an enumerated mirror of Canada Health Infoway's IndigenousIdentityCode ValueSet, source version 1.3.0 (published… |
| LOINC -- all codes | LOINC (Logical Observation Identifiers Names and Codes) -- the international standard for |
| Note Block Types | The render kinds a structured section may declare, bound extensible from the |
| Note Classification Value Set (retired) | RETIRED -- superseded by the Composition Classification Value Set (nexus-emr-composition-classification). Renamed when the Composition profile widened from authored notes alone … |
| Oscar Billing Status Value Set | The 10 raw Oscar Pro billing_on_cheader1.status codes. |
| Oscar Pay Program Value Set | Known Oscar Pro pay_program values verified from backend source (BillingONCHeader1.java + BillingONCHeader1Controller.java + BillingONCHeader1Repository.java). Extensible binding … |
| Patient Flag Type Value Set | Types of singleton administrative patient flags used by Nexus EMR. |
| Patient Record Inactive Reason | Reasons a retired patient record is inactive. |
| Personal Pronouns Value Set | Personal pronoun sets offered by Nexus EMR, from the LOINC personal-pronouns answer list. Extensible: a set outside this list is recordable. Absence reasons are carried as a data-… |
| Prevention Status Value Set | The 3 Nexus EMR Preventions product status codes (Pending was cut from phase-1 scope, 2026-07-28). |
| Primary Care Attachment Status | Status codes for a patient's primary-care attachment. |
| Privacy Exception Purposes Value Set | The purposes of use for which a privacy directive may carry an exception -- the nested permit |
| Privacy Restriction Actions Value Set | The acts a privacy directive can restrict: collection, access, use and disclosure. Bound |
| Province / Territory / State Value Set | Permitted values for Address.state in Nexus EMR: the two-letter Canadian province/territory codes and US state/DC/territory codes as actually stored. Bare subdivision codes, not I… |
| Racialized Group Value Set | Self-identified racialized-group answers offered by Nexus EMR — an enumerated mirror of Canada Health Infoway's RacializedGroupCode ValueSet, source version 1.3.0 (published 2026-… |
| Referral Service Type Value Set | The healthcare service or clinical specialty a referral is directed to. Mirrors Canada Health Infoway's ReferralServiceCategoryCode over SNOMED CT Canadian Edition reference set 3… |
| Roster Termination Reason Value Set | Ontario MoHLTC enrolment/roster termination reasons. |
| SNOMED CT -- all codes | SNOMED CT -- the international clinical terminology, and the system this specification reaches for |
| Task Business Statuses | Business sub-states that can be recorded on a clinical task alongside its lifecycle |
| Task Codes | The category a clinical task is filed under, so a view can sort tasks into bins: reminder, call, |
| Task Priority Details | Priority refinements finer than R4's request-priority allows; currently trivial alone. Required binding: the extension exists to carry a controlled refinement, and an open one w… |
| UCUM units of measure -- all codes | UCUM (the Unified Code for Units of Measure) -- the code system FHIR uses for units on Quantity, |
| WHO ATC classification -- all codes | The Anatomical Therapeutic Chemical (ATC) classification -- the World Health Organization's |
Code systems (30)¶
| Name | Description |
|---|---|
| Appointment Modality Code System | Normalized appointment/encounter delivery-channel codes. Encounter.class mapping: in-person -> #AMB; video |
| Canadian Provincial Health Number Systems CodeSystem | URIs for provincial and territorial health number naming systems across Canada |
| Clinical Roles CodeSystem | Curated Nexus default clinical roles a practitioner performs at an organization (bound extensibly to PractitionerRole.code), for EMR workflow/filtering. A product/design-owned def… |
| Consent Family CodeSystem | Which family a Consent resource belongs to, carried in Consent.category so that a search |
| Nexus EMR Consent Item CodeSystem | The consent items a patient can be asked about, one Consent resource per (patient, item). |
| Contact Purpose Code System | Purposes an alternative contact can serve for a patient, used by the Nexus EMR Patient Profile Relationships section. |
| Document Category CodeSystem | The categories a user can file an uploaded document under, recorded on |
| First Nation Band CodeSystem | Federal band numbers, as maintained by Indigenous Services Canada, used to code a patient's First |
| Form Chart Value CodeSystem | The values a form template's field mapping may draw from a patient's chart. Codes are dotted |
| Indian Act Registration Status CodeSystem | Whether the patient states they are registered under the Indian Act. Minted because no official system was found for these statuses (the Canadian URI Registry names the registrati… |
| Indian Status Card Type CodeSystem | The forms of Indian status documentation issued by Indigenous Services Canada. Minted because no official system for these document types was found. |
| Nexus Composition Type CodeSystem | Summary kinds this estate produces for which LOINC has no concept. |
| Nexus Field Category CodeSystem | The top-level grouping a reportable field belongs to, used to organize the report builder's |
| Nexus Field CodeSystem | The stable identifier for a reportable field, and the full record of that field: what it is |
| Nexus Field Subcategory CodeSystem | The second-level grouping a reportable field belongs to, within its reporting category. Codes |
| Note Block Type CodeSystem | The render kinds a structured note, letter or summary section can declare. |
| OHIP Schedule of Benefits (Ontario fee codes) | The Ontario Health Insurance Plan (OHIP) Schedule of Benefits fee codes -- the service codes |
| Oscar Billing Status Code System | Raw Oscar Pro billing_on_cheader1.status codes (the BillingStatus Java enum at ca.kai.billing.header.BillingONCHeader1). |
| Oscar Pay Program Code System | Oscar Pro pay_program code values. |
| Patient Flag Type Code System | Singleton administrative patient-flag types used by Nexus EMR; the flag's free text is carried on Flag.code.text. |
| Patient Record Inactive Reason CodeSystem | Why a retired patient record is inactive. Death is deliberately not a code here — Patient.deceased[x] is FHIR's native element for it, and there must not be two ways to say it. |
| Prevention Status Code System | Nexus EMR Preventions product status codes (PRD: Preventions Phase 1, §02.04, as amended by the 2026-07-28 scope decision removing Pending). |
| Primary Care Attachment Status CodeSystem | Status of a patient's formal primary-care attachment/enrollment. |
| Province / Territory / State Codes | Two-letter province, territory and state codes as stored in Address.state by Nexus EMR: the 13 Canadian provinces and territories, and the 56 US states, District of Columbia and t… |
| Reporting Picker Id CodeSystem (legacy) | The field ids the report builder's picker used before the Nexus Field CodeSystem existed, |
| Roster Termination Reason Code System | Ontario MoHLTC enrolment/roster termination reasons (OMD CDS), with descriptive codes; each concept's definition records the ministry's numeric enrolment-report code(s). No HL7/SN… |
| Task Business Status CodeSystem | Coarse business sub-states recordable on a clinical task alongside its standard FHIR |
| Task Code CodeSystem | The category a clinical task is filed under, used to organize tasks into bins in a user's view. |
| Task Input Type CodeSystem | Labels for Task.input slots whose meaning is structural rather than descriptive -- the ones a |
| Task Priority Detail CodeSystem | Priority refinements finer than R4's request-priority vocabulary allows. Currently one concept: |
Naming systems (15)¶
| Name | Description |
|---|---|
| NexusAttachmentPacket | Identifies a Nexus EMR attachment packet: the ordered set of chart items assembled to travel with an outbound artifact such as a letter or a referral. A List carrying an identifie… |
| NexusCdsCard | Identifies the decision-support card a suggestion Task was raised under, carried on Task.groupIdentifier so that every suggestion from one evaluation is recoverable as a set with … |
| NexusCdsKey | Identifies the business key carried by resources a decision-support rule writes, so that re-evaluating the rule against the same patient updates the Task it already raised rather … |
| NexusCdsRule | Identifies decision-support rules acting as Device actors in the EMR (Task.requester, Task.owner where work is assigned to an agent, Provenance.agent.who). References under this s… |
| NexusEmrPreventionCatalog | Identifies Nexus EMR prevention catalog entries. Codes are stable kebab-case catalog keys minted by the Nexus prevention catalog module (the app is the source of truth for content… |
| NexusForm | Identifies a Nexus EMR form document. A DocumentReference carrying an identifier under this system IS a form -- the official fillable file, held on the chart as an attached docume… |
| NexusFormTemplate | Identifies a Nexus EMR form template. A DocumentReference carrying an identifier under this system IS a form template -- the official blank file, held tenant-wide with no subject … |
| NexusHarnessGraph | Identifies AI-harness graphs acting as Device actors in the EMR (Task.requester, Task.owner on assignment-to-agent, Provenance.agent.who). References under this system are LOGICAL… |
| NexusHarnessKey | Identifies the business key carried by resources the AI harness writes on its own behalf (suggestion Tasks, pre-generated summary Compositions), so that re-running the producing c… |
| NexusTemplate | Identifies a Nexus EMR template. A List carrying an identifier under this system IS a template (see the Template profile) -- its contained resources are the prototypes it produces… |
| NexusUserId | Identifies an EMR user account -- the login a clinical identity resolves to. PRIVATE INFRASTRUCTURE: external consumers must not depend on it. The authority is internal and not re… |
| OnOhipBillingNumber | Identifies an Ontario OHIP billing number: the provider number the Ontario Ministry of Health assigns to a practitioner who bills OHIP directly, and which Ontario claims are submi… |
| OnRmaNumber | Identifies an Ontario RMA (Reciprocal Medical Association) / group billing number: the identifier an Ontario claim carries when the billing provider submits under a group billing … |
| OnSliCode | Identifies an Ontario Service Location Indicator (SLI): the code naming the physical site at which a service was rendered, which Ontario billing submissions carry on the claim hea… |
| PatientMrn | Identifies a patient's local Medical Record Number (chart number) as issued by the source EMR. EMR-LOCAL: values are unique only within the deployment that issued them, they are a… |
Examples (132)¶
| Name | Description |
|---|---|
| Abdominal Ultrasound Report | Imaging report carrying its acquisition modality in the nexus-imaging-modality extension. This guide models the imaging report rather than the DICOM study, so modality lives on th… |
| Adaeze Okonkwo, RN | Cedarbrook registered nurse -- specimen collector, chart-task owner, and the nurse participant on Avery Linwood's care team |
| Pre-visit summary - appointment of 9 Apr 2025 | The machine-generated summary the per-fact citation Provenance targets. Its section text carries the same statements that Provenance attributes to sources, so the chain is checkab… |
| AI-Drafted Note Accepted by a Clinician | Provenance for an AI-generated encounter note -- two agents distinguished by agent.type (Device author, Practitioner attester) plus the entity list naming the inputs the draft der… |
| AI-Generated Summary With Per-Fact Citations | Provenance for an AI-generated pre-visit summary carrying the attributed-fact extension -- every statement backed by verbatim quotes with run-relative chunk labels, one citation r… |
| Alberta Diabetes Research Portal | Clinical research platform - MORE INFO REQUESTED by Avery |
| Alice Johnson (referral scenario) | Cedarbrook patient referred to cardiology for exertional chest discomfort with T-wave changes |
| Allergy Consult Letter (challenge refuted) | The letter recording that a graded oral challenge refuted the previously reported penicillin allergy. It is the source the chart-update suggestion cites when proposing that the re… |
| Alternative Contact (sister, primary) | Avery's sister as primary alternative contact -- shows relationship carrying BOTH the personal relationship and the contact purposes in one array distinguished only by system, plu… |
| Anemia Consultation Document | Example document reference for anemia consultation note from April 8, 2025, carrying a reviewer's sign-off in the reviewed extension -- who acknowledged the document and when, sta… |
| Anemia Diagnostic Report | Example diagnostic report for anemia workup from April 8, 2025 |
| Appointment With Slot Linkage | Example Appointment booked from a free Slot — demonstrates the new Appointment.slot reference wired in 1.10.0 |
| audit-avery-break-glass-20260903 | |
| audit-avery-chart-read-20250408 | |
| audit-avery-packet-disclosure-20250522 | |
| Avery Anemia Condition | Example condition record for patient Avery Linwood's anemia diagnosis |
| Avery April 8 Encounter | Example patient encounter for Avery Linwood's visit on April 8, 2025 |
| Avery COVID-19 Vaccination (Prevention) | Prevention Immunization for Avery Linwood identified by a nexus-emr-prevention-catalog code; status carried natively (no prevention-status extension on Immunization by design) |
| Avery Diastolic Blood Pressure | Example diastolic blood pressure observation for Avery Linwood |
| Avery Height Observation | Example height measurement observation for Avery Linwood |
| Avery INR (warfarin monitoring) | Therapeutic INR on routine warfarin monitoring. The conclusion is the passage the AI-generated pre-visit summary quotes verbatim, so the citation can be checked against the report… |
| Avery LDL Cholesterol | Calculated LDL above the diabetes treatment target, carrying an interpretation and a reference range. The single laboratory input the Framingham risk assessment cites as its basis |
| Avery Linwood -- Primary Care Team | Care providers for Avery Linwood -- MRP, nurse, and referring physician. Shows role discrimination by system AND code, including the v3 ParticipationType REF fallback the official… |
| Avery Linwood Patient | Example patient record demonstrating Nexus EMR patient profile |
| Avery PAP Screening (Completed Externally) | Prevention screening Observation for Avery Linwood carrying the prevention-status extension (completed-externally) and a nexus-emr-prevention-catalog code; performed at an outside… |
| Avery Pre-Visit Intake Questionnaire | Completed pre-visit intake form for Avery Linwood, carrying authored so it dates correctly into the chart journey timeline. Shows a nested, deliberately unconstrained item tree |
| Avery Smoking Cessation (Refused) | Prevention "other" Observation for Avery Linwood carrying the prevention-status extension (refused) at the April 8 2025 annual physical; native status derives to cancelled |
| Avery Systolic Blood Pressure | Example systolic blood pressure observation for Avery Linwood |
| Avery TDAP Immunization | Example immunization record for TDAP vaccine given to Avery Linwood |
| Avery Type 2 Diabetes Condition | The condition the diabetes care plan addresses, the HbA1c goal is written against and the cardiovascular risk assessment is calculated for. Category is encounter-diagnosis rather … |
| avery-clinicalimpression-20250408 | Assessment: Patient presents with acute symptomatic anemia (hemoglobin 68 g/L) following new-onset dizziness and fatigue. Iron therapy prescribed (ferrous sulfate 325 mg daily) an… |
| Booking Alert Flag | Booking alert for Avery Linwood, stored as one active Flag discriminated by the patient-flag-type coding with the field's free text on code.text. Demonstrates the retire-and-repla… |
| Busy Slot Example | Example NexusEmrCoreSlot in 'busy' state, referenced by a booked Appointment |
| Busy-Tentative Slot Example | Example NexusEmrCoreSlot in 'busy-tentative' state, demonstrating the hold-flow status that only the booking system writes |
| Cardiology Consult Letter (received) | An anticoagulation review that arrived as a file from outside the practice -- a DocumentReference rather than a Composition for exactly that reason. The quoted passage is reproduc… |
| Cedarbrook Clinic -- Nursing Pool | |
| Cedarbrook Family Health | Example healthcare organization demonstrating Nexus EMR organization profile |
| Cedarbrook Family Health - Site A | Example healthcare facility location for Cedarbrook Clinic |
| Cedarbrook Juno EMR Device | Example EMR device record for Cedarbrook Clinic's Juno system |
| Chart-Created Task Example | EMR-born task created from a patient chart -- no identifier, no code, the patient on "for" and no focus (the task is about no one chart element), an opening note carrying its auth… |
| Clinical Task Example | Example clinical task (lab-result follow-up) demonstrating the promoted ClinicalTask profile |
| Consent Withdrawal Evidence Document | Scanned signed AI Scribe consent withdrawal form referenced as evidence from the AI Scribe item consent |
| David Chen (post-discharge scenario) | Cedarbrook patient returned from a hospital admission for pneumonia, subject of the medication reconciliation held by the nursing pool |
| Detailed MedicationRequest Example | Example medication request demonstrating Nexus EMR profile with detailed information |
| Diabetes Annual Review | A form definition using BOTH of SDC's extraction spellings at once, which is the point of the example. Its fixed output rides in a contained transaction Bundle named by `templat… |
| Document Review Task, Completed | A review task filed against a document for a named reviewer, completed once that reviewer acted -- reviewing was the task's whole purpose, so nothing is left to track after it. Th… |
| Dr. Ben - Local MRP Role | The family medicine role binding named as the LOCAL most-responsible physician on Avery Linwood's chart. Half of the pair the attachment example turns on -- the clinic holding the… |
| Dr. Ben (local MRP) | The person behind the local most-responsible-physician role on Avery Linwood's chart. Recorded by given name only, which is how every referring example names him |
| Dr. Dave - Enrolled Provider Role (remote) | The role binding at the practice Avery Linwood is formally ENROLLED with, carried on the primary-care attachment extension. Organization is absent because the enrolling practice s… |
| Dr. Dave (remote enrolled provider) | The person behind the enrolled-provider role at the practice Avery Linwood is rostered with -- a different organization from the one holding her chart |
| Dr. Emil Navarro | Example practitioner record demonstrating Nexus EMR practitioner profile |
| Dr. Emily Carter | Family physician at Cedarbrook. The note author and lab-review task owner across the clinical-task examples |
| Dr. Michael Wong | Family physician at Cedarbrook who requested the diabetes education follow-up in the completed-task example |
| Dr. Navarro Bookable Schedule | Example NexusEmrCoreSchedule for Dr. Navarro at Cedarbrook Site A, 90-day planning horizon |
| Dr. Navarro Family Medicine Role | Example practitioner role linking Dr. Navarro to family medicine practice |
| Dr. Priya Holland | The referring physician who sent Avery Linwood's original cardiology consult -- the care-team participant whose role has no concept in the official participant-role value set |
| Dr. Robert Smith | Family physician at Cedarbrook who raised the cardiology referral in the referral-processing task |
| Enclosures - Internal Medicine referral letter - Avery Linwood | |
| FHIR Gateway Observation Change Subscription | The gateway's change-notification subscription for Observation. channel.payload is deliberately absent, so this is an id-only notification and authorization stays enforced at the … |
| Free Slot Example | Example NexusEmrCoreSlot in 'free' state, demonstrating a 15-minute bookable window |
| Hemoglobin Lab Request | Example service request for hemoglobin laboratory test |
| Hemoglobin Lab Result | Example hemoglobin laboratory result observation |
| Inbound eReferral Routing Envelope | MessageHeader on an inbound cardiology eReferral response. Note R4 gives MessageHeader no identifier element -- response.identifier correlates it with the referral it answers |
| Internal Staff Chat About a Patient | WELL-internal chat message about Avery Linwood, distinguished from eReferral pass-through traffic by the category coding |
| Iron Sample Medication Dispense | Example medication dispense for iron supplement sample given to Avery Linwood |
| Iron Therapy Procedure | Example procedure record for iron therapy prescribed to Avery Linwood |
| Jennifer Martinez (diabetes education scenario) | Cedarbrook patient newly diagnosed with type 2 diabetes, subject of the completed education task |
| John Doe (lab review scenario) | Cedarbrook patient whose July 2025 annual-physical CBC returned a low hemoglobin against a documented history of iron deficiency anemia |
| john-smith-alberta | |
| Linda Patel - Diabetes Education Role | The nursing role binding work is routed to. The same human appears in the completed-task example as two different references -- this role as owner, the Practitioner as note author… |
| Linda Patel, RN CDE | Cedarbrook nurse and certified diabetes educator. The PERSON who authors the education-session notes; the role she is assigned work through is a separate resource |
| Maria Gonzalez (AI triage scenario) | Cedarbrook patient who raised a portal message about home blood-pressure readings, triaged with AI assistance under human oversight |
| Naproxen 500mg BID (proposed) | The PROPOSED half of the warfarin/NSAID interaction pair. Status draft is what makes it a proposal -- the profile pins intent to order, so an uncommitted order is distinguished by… |
| Nexus CQL model definition | The CQL ModelInfo for this specification, generated from its own profiles. A criteria library that declares using Nexus version '1.25.1' resolves retrieves against these types, … |
| Nexus EMR AllergyIntolerance Example | Example allergy intolerance record demonstrating Nexus EMR profile |
| Nexus EMR App Consent - DENIED Example | FHIR R4 consent deny pattern - patient declined WellnessTracker Pro (3:45 PM) |
| Nexus EMR App Consent - GRANTED Example | FHIR R4 consent grant pattern - patient consented to SmartDocs AI Scribe (10:30 AM) |
| Nexus EMR App Consent - PROPOSED Example | FHIR R4 consent request pattern - more info needed for research study (2:15 PM) |
| Nexus EMR Appointment Example | Example appointment with requested period demonstrating Nexus EMR profile |
| Nexus EMR AppState Example | Example application state record demonstrating Nexus EMR AppState profile |
| Nexus EMR Invoice Example | Example OHIP billing invoice with 2 line items (A007 general assessment + K030 chronic care premium) demonstrating oscarBillingStatus, shadowBill, and payProgram extensions |
| Nexus EMR Item Consent - AI Scribe DECLINED With Evidence Example | Item consent withdrawn by the patient for the AI Scribe item, with a status reason and a sourceReference to the signed withdrawal form |
| Nexus EMR Item Consent - Clinic-Defined Item With An Expiry Example | An item no vendor catalogue names -- clinical photography -- carried on the clinicDefined slice as the LOINC 59284-0 marker plus the clinic's own tenant-scoped coding and a human-… |
| Nexus EMR Item Consent - Email PROVIDED Example | Item consent for the Email item reading Provided (provision.type permit), recorded by Dr. Navarro, carrying the deterministic {patient-id}:{item-code} identifier |
| Nexus EMR Item Consent - Expired PERMIT Example | A permit whose provision.period has elapsed -- valid, operative and NOT permission. The worked example for the rule that a consumer reads the period as well as provision.type, and… |
| Nexus EMR Item Consent - SMS DECLINED Example | Item consent for the SMS item reading Declined (provision.type deny), demonstrating the free-text status reason extension |
| nexus-emr-careplan-example | |
| nexus-emr-clinical-task-correction-request-denied | Patient requests correction of LDL result of 8 April 2026; states sample was non-fasting. |
| nexus-emr-core-appointment-example-telephone | |
| nexus-emr-core-clinical-task-ai-triage-001 | Review a patient portal message about blood-pressure concerns, triaged with AI assistance. The ask is this description; the patient's message is the first turn in the thread (note… |
| nexus-emr-core-clinical-task-completed-001 | Provide diabetes education follow-up for Jennifer Martinez. Review blood glucose logs, insulin adjustment, and dietary counseling. Patient newly diagnosed with Type 2 diabetes. |
| nexus-emr-core-clinical-task-lab-review-001 | Review CBC results for John Doe - flagged values need clinical assessment. Hemoglobin 8.2 g/dL (low), requires evaluation for anemia workup. |
| nexus-emr-core-clinical-task-nursing-pool-001 | Complete medication reconciliation for David Chen following hospital discharge. Patient returned from Calgary General Hospital after pneumonia treatment. Reconcile discharge medic… |
| nexus-emr-core-clinical-task-referral-001 | Process cardiology referral for Alice Johnson - chest pain evaluation. Patient reports intermittent chest discomfort with exertion. ECG shows possible T-wave abnormalities in lead… |
| nexus-emr-coverage-example | |
| nexus-emr-familymemberhistory-example | |
| nexus-emr-goal-example | |
| nexus-emr-medicationstatement-example | |
| nexus-emr-riskassessment-example | |
| nexus-privacy-directive-lockbox-named-record | |
| nexus-privacy-directive-lockbox-whole-record | |
| Patient Not Enrolled (decided negative) | Patient demonstrating primaryCareAttachment.status = not-enrolled, the decided "deliberately not rostered" state, distinct from an absent attachment |
| Patient Seen Fee-for-Service | Patient demonstrating primaryCareAttachment.status = fee-for-service, not rostered but not due to termination |
| Patient With Indigenous Profile Fields | Patient carrying the Indigenous profile surface — Indian Act registration status, First Nation registry group and community as flat extensions, and the status card as an Indian re… |
| Patient With No Health Card (identity surface) | Patient with no provincial health card, carrying Ontario's CA-eReC reason-for-no-HCN extension on the MRN identifier, plus genderIdentity and pronouns in their correct COMPLEX for… |
| Patient with Primary Care Attachment | Patient demonstrating primaryCareAttachment (local MRP Ben, remote enrolled provider Dave) plus the MRN identifier slice |
| Priya Raman, RN | Cedarbrook registered nurse, member of the nursing pool and holder of the day-shift triage role binding |
| Progress Note - 8 Apr 2025 | |
| Referral - Internal Medicine - Avery Linwood | |
| Referral Received Over Ontario eReferral | A cardiology referral as it arrives from Ocean -- intent proposal, the destination in category and no code element, which is the shape the Ontario eReferral contract sends. Demons… |
| Sarah Wilson, MOA | Cedarbrook medical office assistant who processes referral paperwork and insurance verification |
| Encounter Note - 10 Aug 2026 | The signed note whose prose states type 2 diabetes without it being on the problem list -- the passage the chart-update extraction quotes when it suggests the addition. No identif… |
| Since last visit - Avery Linwood | |
| Since last visit - Avery Linwood (converted) | |
| SmartDocs AI Scribe App | AI clinical documentation app - CONSENT GRANTED by Avery |
| Specialist Referral Letter | A one-entry template -- a List whose single contained prototype is the Composition a specialist referral letter will become. The prototype carries no subject because a template is… |
| Statement Of Disagreement - Element-Targeted | A patient's statement about a refused correction, associated with both the disputed version and the logical record, each carrying a targetPath extension naming the disputed elemen… |
| Suggested-Resource Task - Add a Chart Entry | A suggested chart entry awaiting a decision. The suggested resources ride in a contained transaction Bundle whose single entry is the suggested Condition, carrying the POST that i… |
| Suggested-Resource Task - Card Alternative A (empagliflozin) | One of two mutually exclusive proposals raised by a single decision-support evaluation. Both carry intent = option and the same groupIdentifier under NamingSystem/nexus-cds-card, … |
| Suggested-Resource Task - Card Alternative B (dulaglutide) | The sibling of card alternative A -- same groupIdentifier, same intent = option, a different suggested MedicationRequest. Shows that grouping records what was raised together whil… |
| Suggested-Resource Task - Retire a Chart Entry | A suggestion that CHANGES something already in the chart rather than adding to it. The Bundle entry carries a conditional PUT over the recorded penicillin allergy, and the prototy… |
| Team-Owned Standalone Task Example | Standalone work item with no patient context, held by a CareTeam -- exercising the optional "for" and the CareTeam owner target, with the ask as its opening note |
| Telephone Note - 20 May 2025 (amended) | |
| Tobacco Use | A form definition demonstrating the three things that distinguish a Nexus form from a bare R4 Questionnaire -- canonical identity (url + version), a CONTAINED prototype of the res… |
| Triage Nurse - Day Shift Role | The day-shift triage binding, held by Priya Raman, RN. AI-assisted triage is restricted to this ROLE so a human triage nurse stays the recipient of record regardless of who is on … |
| Venous Blood Specimen (CBC) | Blood draw behind Avery Linwood's April 8 2025 CBC. Shows the accessionIdentifier contract -- the performing lab's number, deliberately distinct from the specimen's own identifier… |
| Walk-in Appointment Example | Example Appointment created without a Slot reference, demonstrating the 0..* cardinality on Appointment.slot for historical and walk-in cases |
| Warfarin 5mg Daily (existing) | The EXISTING half of the warfarin/NSAID interaction pair -- the prescription already in force when the naproxen order was entered |
| Warfarin/NSAID Interaction with Prescriber Override | Drug-drug interaction detected during prescribing for Avery Linwood, overridden by Dr. Navarro with recorded rationale. Demonstrates the medico-legal override trail -- status stay… |
| WellnessTracker Pro App | Personal wellness monitoring app - CONSENT DENIED by Avery |
| WSIB Form 8 (filed) | A WSIB Form 8 filled for a patient and filed on the chart, marked under nexus-form with the same slug as its template and carrying no mapping -- the filled values are in the file |
| WSIB Form 8 Template (with field mapping) | The tenant-wide blank of WSIB Form 8 -- subject-less, marked under nexus-form-template, readonly because it is system-provisioned -- carrying the field mapping that pre-fills the … |