Nexus EMR Item Consent Profile Core Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-item-consent |
|---|---|
| Status | draft · 1.26.0 |
| Base | Consent (constraint) |
| Source | FSH · JSON |
Patient-level consent for one catalogue item — whether the clinic may email the patient, text the patient, or use an AI scribe during their visit. Recorded manually by clinic staff from what the patient tells them, not captured through a patient-facing flow.
Elements / Snapshot
The full effective definition: base Consent with this profile's constraints applied.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | 0..* | Patient consent for one catalogue item (Email | SMS | AI Scribe) Core i Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, item-consent-status-is-defined, item-consent-performer-is-attributable |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| versionId | 0..1 | id | Version specific identifier i Invariants: ele-1 |
|
| lastUpdated | 0..1 | instant | When the resource version last changed i Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| profile | 0..* | canonical | Profiles this resource claims to conform to i Invariants: ele-1 |
|
| security | 0..* | Coding | Security Labels applied to this resource i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| tag | 0..* | Coding | Tags applied to this resource i Binding: common-tags ( example)Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation i Invariants: ele-1 |
|
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:statusReason | S | 0..1 | Extension(Consent Status Reason Extension) | Free-text reason for the current status (typically on revocation) i Invariants: ele-1, ext-1 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| identifier | S | 0..* | Identifier | Business identifier(s) for item consent i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| type | 0..1 | CodeableConcept | Description of identifier i Binding: identifier-type ( extensible)Invariants: ele-1 |
|
| system | 1..1 | uri | The namespace for the identifier value i Invariants: ele-1 |
|
| value | 1..1 | string | The value that is unique i Invariants: ele-1 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) i Invariants: ele-1 |
|
| status | S ?! | 1..1 | code | active (the record is operative) | entered-in-error i Binding: consent-state-codes ( required)Invariants: ele-1 |
| scope | S ?! | 1..1 | CodeableConcept | patient-privacy - Privacy consent Fixed: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/consentscope","code":"patient-privacy","display":"Privacy C…Binding: consent-scope ( required)Invariants: ele-1 |
| category | S | 2..* | CodeableConcept | The consent item this resource records (Email | SMS | AI Scribe), plus the family code i Slicing: pattern:coding.system (open) Binding: consent-category ( extensible)Invariants: ele-1 |
| category:item | S | 1..1 | CodeableConcept | The consent item (single coding from the Nexus consent-item CodeSystem) i Binding: Nexus EMR Consent Items ( extensible)e.g. email · sms · ai-scribeInvariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 1..1 | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Fixed: ../CodeSystem/nexus-consent-itemInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| category:family | S | 1..1 | CodeableConcept | Fixed: this Consent is an item consent i Binding: Consent Families Value Set ( required)e.g. app · item · privacy-directiveInvariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 1..1 | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Fixed: ../CodeSystem/nexus-consent-familyInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 1..1 | code | Symbol in syntax defined by the system Fixed: itemInvariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| patient | S | 1..1 | Reference(Patient Profile) | The patient whose consent this is i Invariants: ele-1 |
| dateTime | S | 1..1 | dateTime | When THIS status was recorded i Invariants: ele-1 |
| performer | S | 0..1 | Reference(Patient Profile | Practitioner Profile | PractitionerRole Profile) | Who made the consent decision (the patient, or the staff member who recorded it) i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| reference | 0..1 | string | Literal reference, Relative, internal or absolute URL i Invariants: ele-1 |
|
| type | 0..1 | uri | Type the reference refers to (e.g. "Patient") i Binding: resource-types ( extensible)Invariants: ele-1 |
|
| identifier | 0..1 | Identifier | Logical reference, when literal reference is not known i Invariants: ele-1 |
|
| display | S | 0..1 | string | How the decision-maker is named to the reader i Invariants: ele-1 |
| organization | 0..* | Reference(Organization) | Custodian of the consent Invariants: ele-1 |
|
| source[x] | 0..1 | Reference(DocumentReference Profile) | Source from which this consent is taken i Slicing: type:$this (open) Invariants: ele-1 |
|
| source[x]:sourceReference | S | 0..1 | Reference(DocumentReference Profile) | Evidence document for THIS status change, if one was captured i Invariants: ele-1 |
| policy | S | 1..* | BackboneElement | The policy this consent is given under Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| authority | 0..1 | uri | Enforcement source for policy Invariants: ele-1 |
|
| uri | 1..1 | uri | Specific policy covered by this consent i Invariants: ele-1 |
|
| policyRule | 0..1 | CodeableConcept | Regulation that this consents to i Binding: consent-policy ( extensible)Invariants: ele-1 |
|
| verification | 0..* | BackboneElement | Consent Verified by patient or family Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| verified | 1..1 | boolean | Has been verified Invariants: ele-1 |
|
| verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified Invariants: ele-1 |
|
| verificationDate | 0..1 | dateTime | When consent verified Invariants: ele-1 |
|
| provision | S | 1..1 | BackboneElement | The decision: permit (Provided) | deny (Declined) Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| type | S | 1..1 | code | permit (Provided) | deny (Declined or withdrawn) Binding: consent-provision-type ( required)Invariants: ele-1 |
| period | 0..1 | Period | Timeframe for this rule Invariants: ele-1 |
|
| actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| role | 1..1 | CodeableConcept | How the actor is involved Binding: security-role-type ( extensible)Invariants: ele-1 |
|
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) Invariants: ele-1 |
|
| action | 0..* | CodeableConcept | Actions controlled by this rule i Binding: consent-action ( example)Invariants: ele-1 |
|
| securityLabel | 0..* | Coding | Security Labels that define affected resources i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| purpose | 0..* | Coding | Context of activities covered by this rule i Binding: v3-PurposeOfUse ( extensible)Invariants: ele-1 |
|
| class | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. i Binding: consent-content-class ( extensible)Invariants: ele-1 |
|
| code | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content i Binding: consent-content-code ( example)Invariants: ele-1 |
|
| dataPeriod | 0..1 | Period | Timeframe for data controlled by this rule i Invariants: ele-1 |
|
| data | 0..* | BackboneElement | Data controlled by this rule Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| meaning | 1..1 | code | instance | related | dependents | authoredby Binding: consent-data-meaning ( required)Invariants: ele-1 |
|
| reference | 1..1 | Reference(Resource) | The actual data reference Invariants: ele-1 |
|
| provision | 0..* | Reserved for future per-purpose granularity Invariants: ele-1 |