Profiles & Operations Index > Profile: Consent

Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Consent

Simplifier project page: Consent

Derived from: Consent (R4)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idΣ0..1id
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
statusS Σ ?!1..1codeBindingFixed Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeΣ0..1dateTime
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
sourceAttachmentAttachment
sourceReferenceReference(Consent | Contract | DocumentReference | QuestionnaireResponse)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
authorityS C1..1uriFixed Value
uriC0..1uri
policyRuleΣ C0..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
verifiedΣ1..1boolean
verifiedWithC0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
typeS Σ1..1codeBindingFixed Value
periodΣ C0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
securityLabelΣ0..*CodingBinding
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
codeΣ0..*CodeableConcept
dataPeriodΣ C0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
meaningΣ1..1codeBinding
referenceΣ C1..1Reference(Resource)
provision0..*see (provision)

Hybrid View

idΣ0..1id
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
statusS Σ ?!1..1codeBindingFixed Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeΣ0..1dateTime
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
sourceAttachmentAttachment
sourceReferenceReference(Consent | Contract | DocumentReference | QuestionnaireResponse)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
authorityS C1..1uriFixed Value
uriC0..1uri
policyRuleΣ C0..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
verifiedΣ1..1boolean
verifiedWithC0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
typeS Σ1..1codeBindingFixed Value
periodΣ C0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
securityLabelΣ0..*CodingBinding
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
codeΣ0..*CodeableConcept
dataPeriodΣ C0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
meaningΣ1..1codeBinding
referenceΣ C1..1Reference(Resource)
provision0..*see (provision)

Snapshot View

idΣ0..1id
id0..1string
extensionC0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionC0..*Extension
modifierExtension?! C0..*Extension
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
statusS Σ ?!1..1codeBindingFixed Value
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeΣ0..1dateTime
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
sourceAttachmentAttachment
sourceReferenceReference(Consent | Contract | DocumentReference | QuestionnaireResponse)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
authorityS C1..1uriFixed Value
uriC0..1uri
policyRuleΣ C0..1CodeableConceptBinding
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
verifiedΣ1..1boolean
verifiedWithC0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
typeS Σ1..1codeBindingFixed Value
periodΣ C0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionC0..*Extension
referenceS Σ C1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
securityLabelΣ0..*CodingBinding
id0..1string
extensionC0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionC0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
codeΣ0..*CodeableConcept
dataPeriodΣ C0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
meaningΣ1..1codeBinding
referenceΣ C1..1Reference(Resource)
provision0..*see (provision)

Table View

Consent..
Consent.meta1..
Consent.meta.profile1..
Consent.identifier..
Consent.identifier.use..
Consent.status..
Consent.scope..
Consent.scope.coding1..1
Consent.scope.coding.system1..
Consent.scope.coding.code1..
Consent.scope.coding.display1..
Consent.category..1
Consent.category.coding1..1
Consent.category.coding.system1..
Consent.category.coding.code1..
Consent.category.coding.display1..
Consent.patientReference(Patient)1..
Consent.patient.reference1..
Consent.performerReference(Organization | Patient | Practitioner | RelatedPerson)1..1
Consent.performer.reference1..
Consent.organizationReference(Organization)1..1
Consent.organization.reference1..
Consent.policy1..1
Consent.policy.authority1..
Consent.provision1..
Consent.provision.type1..
Consent.provision.period..
Consent.provision.actor1..1
Consent.provision.actor.role..
Consent.provision.actor.role.coding1..1
Consent.provision.actor.role.coding.system1..
Consent.provision.actor.role.coding.code1..
Consent.provision.actor.role.coding.display1..
Consent.provision.actor.referenceReference(Practitioner)..
Consent.provision.actor.reference.reference1..
Consent.provision.action..
Consent.provision.action.coding1..1
Consent.provision.action.coding.system1..
Consent.provision.action.coding.code1..
Consent.provision.action.coding.display1..
Consent.provision.purpose1..1
Consent.provision.purpose.system1..
Consent.provision.purpose.code1..
Consent.provision.purpose.display1..
Consent.provision.class1..
Consent.provision.class.system1..
Consent.provision.class.code1..
Consent.provision.class.display1..

JSON View

{
"resourceType": "StructureDefinition",
"id": "0175c4e8-6286-4a98-a433-7dfa28b04214",
"meta": {
"lastUpdated": "2025-10-30T18:10:21.4346106+00:00"
},
"url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Consent",
"version": "2.0.0",
"name": "ConsentV2",
"status": "active",
"date": "2024-04-30T16:33:59.6728098+00:00",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Consent",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent",
"derivation": "constraint",
"element": [
{
"id": "Consent",
"path": "Consent",
{
"key": "inv-1",
"severity": "error",
"human": "If consent performer is relatedPerson, provision purpose code MUST be \"SUPNWK\"",
"expression": "performer.resolve().meta.profile.contains('RelatedPerson') implies provision.purpose[0].code='SUPNWK'"
}
]
},
{
"id": "Consent.meta",
"path": "Consent.meta",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.meta.profile",
"path": "Consent.meta.profile",
"comment": "#### **_` FOR PCOI USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Consent|2.0.0 `_** \n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.identifier",
"path": "Consent.identifier",
"definition": "Unique identifier for this copy of the Consent Statement.\neHealth Ontario and Implementers will work together to define the value passed in this field, if any.",
"comment": "This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.\nTBD if an identifier is necessary; this field can be used to store an identifier from the submitting system for reconciliation. DICS requires a msid from the Message Header (this value can come from the client, or could be HIAL/Gateway-assigned). CDR uses msgid from the SOAP Header <wsa:MessageID> from the SOAP request msg. CMTA or the gateway would need to turn/store this ID for future retrieval/reference.",
"mustSupport": false
},
{
"id": "Consent.identifier.use",
"path": "Consent.identifier.use",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
{
"id": "Consent.status",
"path": "Consent.status",
"definition": "Indicates the current state of this consent.\nFor consent overrides, this value will be fixed to \"active\".",
"fixedCode": "active",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1"
}
},
{
"id": "Consent.scope",
"path": "Consent.scope",
"mustSupport": true
},
{
"id": "Consent.scope.coding",
"path": "Consent.scope.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.scope.coding.system",
"path": "Consent.scope.coding.system",
"min": 1,
"fixedUri": "http://terminology.hl7.org/CodeSystem/consentscope",
"mustSupport": true
},
{
"id": "Consent.scope.coding.code",
"path": "Consent.scope.coding.code",
"min": 1,
"fixedCode": "patient-privacy",
"mustSupport": true
},
{
"id": "Consent.scope.coding.display",
"path": "Consent.scope.coding.display",
"min": 1,
"fixedString": "Privacy Consent",
"mustSupport": true
},
{
"id": "Consent.category",
"path": "Consent.category",
"max": "1",
"mustSupport": true
},
{
"id": "Consent.category.coding",
"path": "Consent.category.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.category.coding.system",
"path": "Consent.category.coding.system",
"min": 1,
"fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"mustSupport": true
},
{
"id": "Consent.category.coding.code",
"path": "Consent.category.coding.code",
"min": 1,
"fixedCode": "INFA",
"mustSupport": true
},
{
"id": "Consent.category.coding.display",
"path": "Consent.category.coding.display",
"min": 1,
"fixedString": "information access",
"mustSupport": true
},
{
"id": "Consent.patient",
"path": "Consent.patient",
"min": 1,
"type": [
{
"code": "Reference",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Patient"
]
}
],
"mustSupport": true
},
{
"id": "Consent.patient.reference",
"path": "Consent.patient.reference",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.performer",
"path": "Consent.performer",
"definition": "Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.\nOnly Patient and RelatedPerson are in the scope of the current release. Practitioner-initiated Consent Override",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Patient",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-RelatedPerson",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Practitioner",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Organization"
]
}
],
"mustSupport": true
},
{
"id": "Consent.performer.reference",
"path": "Consent.performer.reference",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.organization",
"path": "Consent.organization",
"definition": "The organization that manages the consent, and the framework within which it is executed.\nFor PCOI, this captures the facility name and identifier of the \"Under Authority Of\" organization.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Organization"
]
}
],
"mustSupport": true
},
{
"id": "Consent.organization.reference",
"path": "Consent.organization.reference",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.policy",
"path": "Consent.policy",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.policy.authority",
"path": "Consent.policy.authority",
"min": 1,
"fixedUri": "http://www.ontario.ca",
"mustSupport": true
},
{
"id": "Consent.provision",
"path": "Consent.provision",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.type",
"path": "Consent.provision.type",
"min": 1,
"fixedCode": "permit",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-provision-type"
}
},
{
"id": "Consent.provision.period",
"path": "Consent.provision.period",
"definition": "The timeframe in this rule is valid.\n\nThis field is optional and will be ignored for processing in the current PCOI implementation. The consent override duration will be processed based on the time of receipt of the FHIR Consent resource, and not based on the payload's Consent.dateTime value (to prevent unintended behaviour based on incorrect payload dateTime)."
},
{
"id": "Consent.provision.actor",
"path": "Consent.provision.actor",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.provision.actor.role",
"path": "Consent.provision.actor.role",
"mustSupport": true
},
{
"id": "Consent.provision.actor.role.coding",
"path": "Consent.provision.actor.role.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.provision.actor.role.coding.system",
"path": "Consent.provision.actor.role.coding.system",
"min": 1,
"fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"mustSupport": true
},
{
"id": "Consent.provision.actor.role.coding.code",
"path": "Consent.provision.actor.role.coding.code",
"min": 1,
"fixedCode": "IRCP",
"mustSupport": true
},
{
"id": "Consent.provision.actor.role.coding.display",
"path": "Consent.provision.actor.role.coding.display",
"min": 1,
"fixedString": "information recipient",
"mustSupport": true
},
{
"id": "Consent.provision.actor.reference",
"path": "Consent.provision.actor.reference",
"type": [
{
"code": "Reference",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Practitioner"
]
}
],
"mustSupport": true
},
{
"id": "Consent.provision.actor.reference.reference",
"path": "Consent.provision.actor.reference.reference",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.action",
"path": "Consent.provision.action",
"definition": "Actions controlled by this Rule.\n\nWhile this element may be used by some underlying lines of business (e.g. DHDR), the PCOI currently is not using this optional element. If sent, this element will not be processed by the PCOI.\n\nSee comments.",
"comment": "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.\n\nAs of FHIR R4, HL7 notes that \"At present, the only action in the understood and tested scope of this resource is 'read'\". (yet \"read\" is not one of the sample Consent Action Codes).\n\nThis element may be populated with the value \"use\", to align with the example binding and with the current DHDR implementation, but may require additional discussion. Note that DHDR V1 and V2 used value \"access\", while DHDR V3 used \"use\".",
"mustSupport": true,
"binding": {
"strength": "required"
}
},
{
"id": "Consent.provision.action.coding",
"path": "Consent.provision.action.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.provision.action.coding.system",
"path": "Consent.provision.action.coding.system",
"min": 1,
"fixedUri": "http://terminology.hl7.org/CodeSystem/consentaction",
"mustSupport": true
},
{
"id": "Consent.provision.action.coding.code",
"path": "Consent.provision.action.coding.code",
"min": 1,
"fixedCode": "use",
"mustSupport": true
},
{
"id": "Consent.provision.action.coding.display",
"path": "Consent.provision.action.coding.display",
"min": 1,
"fixedString": "Use",
"mustSupport": true
},
{
"id": "Consent.provision.purpose",
"path": "Consent.provision.purpose",
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.\nThis element captures the \"reason for override\". Ontario legislation currently allows for:\n* Express Patient Consent [PATRQT]\n* Express Substitute Decision Maker Consent [SUPNWK}\n* Risk to Safety of Patient [OVRER]\n* Risk to Safety of Third Parites [OVRTPS]\nNot all systems will allow all three reasons for override, however. Please see additional documentation for details.",
"min": 1,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://ehealthontario.ca/fhir/ValueSet/consent-pcoi-override-reason"
}
},
{
"id": "Consent.provision.purpose.system",
"path": "Consent.provision.purpose.system",
"min": 1,
"fixedUri": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
"mustSupport": true
},
{
"id": "Consent.provision.purpose.code",
"path": "Consent.provision.purpose.code",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.purpose.display",
"path": "Consent.provision.purpose.display",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.class",
"path": "Consent.provision.class",
"definition": "The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.\nThe classes identified will indicate the Ontario EHR repository for which the Consent Override is being requested. As additional Ontario EHR respositories are onboarded to the Provincial Consent Override Interface service, the bound ValueSet will be updated to include those repositories.",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Codes representing data domains for PCOI including OH Clinical Data Foundation, and legacy repositories",
"valueSet": "http://ontariohealth.ca/fhir/pcoi/ValueSet/consent-content-class"
}
},
{
"id": "Consent.provision.class.system",
"path": "Consent.provision.class.system",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.class.code",
"path": "Consent.provision.class.code",
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).\nThis will contain the gateway URI identifying the provincial EHR assets as a target for the consent override request",
"comment": "#### **_`For this release, the supported values are http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-MedicationDispense for DHDR consent override or http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-DiagnosticReport for OLIS consent override`_**",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.provision.class.display",
"path": "Consent.provision.class.display",
"comment": "#### **_`For this release, the supported values are \"DHDR\" for DHDR consent override or \"OLIS\" for OLIS consent override`_**",
"min": 1,
"mustSupport": true
}
]
}
}

Usage

The Consent resource is the main resource for the PCOI operations (Create Concent, CreateDHDRPDF.

Notes

The following rules apply to message type Bundles only

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-consent-pcoi-profile-Consent|2.0.0

.status

  • populate with a fixed value: active

.scope.coding

  • populate .scope.coding.system with a fixed value: http://terminology.hl7.org/CodeSystem/consentscope
  • populate .scope.coding.code with a fixed value: patient-privacy
  • populate .scope.coding.display with a fixed value: Privacy Consent

.category.coding

  • populate .category.coding.system with a fixed value: http://terminology.hl7.org/CodeSystem/v3-ActCode
  • populate .category.coding.code with a fixed value: INFA
  • populate .category.coding.display with a fixed value: information access

.patient.reference

  • populate with the patient.id of the contained Patient resource

.performer.reference

  • populate with the patient.id/relatedperson.id/practitioner.id of the contained Patient/RelatedPerson/Pracitioner resource, depending on who is enacting the consent override

.organization.reference

  • populate with the organization.id of the contained Organization resource under whose UAO the consent override is occurring (typically the organization of the physician who wishes to viewg the protected record)

.policy.authority

  • populate with a fixed value: http://www.ontario.ca

.provision.type

  • populate with a fixed value: permit

.provision.actor.role.coding

  • populate .provision.actor.role..coding.system with a fixed value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
  • populate .provision.actor.role.coding.code with a fixed value: IRCP
  • populate .provision.actor.role.coding.display with a fixed value: information recipient

.provision.actor.reference

  • populate with the practitioner.id of the physician who wishes to view the protected record

.provision.action

  • SHOULD populate value "use" from the FHIR defined value set for "Consent Action".
  • Note that the value "use" is currently used by DHDR and OLIS to indicate the override action is support the use of the data for downstream systems. In the future, we will evaluate the need for this element with other integrating EHR asset, and may change or support other values.

.provision.class

  • SHALL populate the applicable values depending on the clinical repository to override. The value MUST come from ConsentContentClass value set.
    • For legacy DHDR override, class.system should be urn:ietf:rfc:3986, class.code should be http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-MedicationDispense
    • For OLIS override, class.system should be urn:ietf:rfc:3986, class.code should be http://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-DiagnosticReport
    • For CDF DHDR override, class.system should be http://ontariohealth.ca/fhir/ehr/CodeSystem/cdf-data-domains, class.code should be drugs