Skip to content

Consent Family CodeSystem Code system

Canonicalhttps://fhir.apps.health/CodeSystem/nexus-consent-family
Statusdraft · 1.33.0
Contentcomplete
SourceFSH · JSON

Which family a Consent resource belongs to, carried in Consent.category so that a search returning several families can be told apart before any of them is interpreted.

Every Consent profile in this guide carries one of these codes, in the family slice of category, and that element is searchable -- so a family is selected in the search rather than sorted out after it:

GET Consent?patient={id}&category=https://fhir.apps.health/CodeSystem/nexus-consent-family|{code}

Omitting the category returns all three families mixed, because all three carry scope = patient-privacy and scope separates nothing.

This code says WHAT a decision governs -- an application, a catalogue item, or the record itself. It does not say how to read the decision, because every family reads the same way: the decision is provision.type on the root provision, permit grants, deny restricts, and status says only whether the record is operative.

That uniformity is new. Families used to disagree, and one element meaning opposite things across resources sharing a type, a scope and a search is how restricted information gets disclosed -- so the divergence was removed rather than documented around. A consumer MUST NOT read a decision out of status, and MUST NOT infer the family from status, scope, or the shape of the provision tree.

CodeDisplayDefinition
appApplication consentWhether the patient agreed to share their record with a named third-party application. `provision.type = permit` on the root is agreement, `deny` is refusal. Carried by the App Consent profile. Refusal used to be a nested deny and a grant the absence of one, which meant a truncated resource read as a grant.
itemItem consentThe patient's answer for one catalogue item -- email, SMS, AI scribe. `provision.type = permit` is yes, `deny` is no or withdrawn. Carried by the Item Consent profile. This family used to carry its answer in `status` alone, which is the divergence this guide removed: it made an active item consent mean permission while an active privacy directive means a restriction in force.
privacy-directivePrivacy directiveA standing patient restriction on the collection, use or disclosure of their personal health information -- what PHIPA calls a lockbox. `provision.type = deny` on the root is the restriction; `status = active` says only that the record is operative. Carried by the Privacy Directive profile.