FHIR Artifacts > Structure Definition: Consent Profile

Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-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

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBindingFixed Value
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeS Σ0..1dateTime
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
sourceAttachmentAttachment
sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
authorityI0..1uri
uriI0..1uri
policyRuleΣ I0..1CodeableConceptBinding
verifiedΣ1..1boolean
verifiedWithI0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
typeS Σ0..1codeBindingFixed Value
startS Σ I0..1dateTime
endS Σ I0..1dateTime
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
codeΣ0..*CodeableConcept
dataPeriodΣ I0..1Period
meaningS Σ1..1codeBinding
referenceS Σ I1..1Reference(Resource)
provision0..*see (provision)

Hybrid View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBindingFixed Value
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeS Σ0..1dateTime
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
sourceAttachmentAttachment
sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
authorityI0..1uri
uriI0..1uri
policyRuleΣ I0..1CodeableConceptBinding
verifiedΣ1..1boolean
verifiedWithI0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
typeS Σ0..1codeBindingFixed Value
startS Σ I0..1dateTime
endS Σ I0..1dateTime
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
codeΣ0..*CodeableConcept
dataPeriodΣ I0..1Period
meaningS Σ1..1codeBinding
referenceS Σ I1..1Reference(Resource)
provision0..*see (provision)

Snapshot View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBindingFixed Value
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeS Σ0..1dateTime
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
sourceAttachmentAttachment
sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
authorityI0..1uri
uriI0..1uri
policyRuleΣ I0..1CodeableConceptBinding
verifiedΣ1..1boolean
verifiedWithI0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
typeS Σ0..1codeBindingFixed Value
startS Σ I0..1dateTime
endS Σ I0..1dateTime
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
codeΣ0..*CodeableConcept
dataPeriodΣ I0..1Period
meaningS Σ1..1codeBinding
referenceS Σ I1..1Reference(Resource)
provision0..*see (provision)

Table View

Consent..
Consent.meta1..
Consent.meta.profile1..
Consent.identifier..
Consent.identifier.system..
Consent.identifier.value..
Consent.status..
Consent.scope..
Consent.scope.coding..
Consent.scope.coding.system..
Consent.scope.coding.code..
Consent.scope.coding.display..
Consent.category..
Consent.category.coding..
Consent.category.coding.system..
Consent.category.coding.code..
Consent.category.coding.display..
Consent.patientReference(Patient)..
Consent.patient.reference1..
Consent.dateTime..
Consent.performerReference(PractitionerRole)..
Consent.performer.reference1..
Consent.organizationReference(Organization)..
Consent.organization.reference1..
Consent.provision1..
Consent.provision.type..
Consent.provision.period..
Consent.provision.period.start..
Consent.provision.period.end..
Consent.provision.actor..
Consent.provision.actor.role..
Consent.provision.actor.role.coding..
Consent.provision.actor.role.coding.system..
Consent.provision.actor.role.coding.code..
Consent.provision.actor.role.coding.display..
Consent.provision.actor.referenceReference(PractitionerRole)..
Consent.provision.actor.reference.reference1..
Consent.provision.action..
Consent.provision.action.coding..
Consent.provision.action.coding.system..
Consent.provision.action.coding.code..
Consent.provision.action.coding.display..
Consent.provision.securityLabel..
Consent.provision.securityLabel.system..
Consent.provision.securityLabel.code..
Consent.provision.securityLabel.display..
Consent.provision.purpose..
Consent.provision.purpose.system..
Consent.provision.purpose.code..
Consent.provision.purpose.display..
Consent.provision.class..
Consent.provision.class.system..
Consent.provision.class.code..
Consent.provision.class.display..
Consent.provision.data..
Consent.provision.data.meaning..
Consent.provision.data.reference..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-eReferral-profile-Consent",
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Consent",
    "version": "1.0.0",
    "name": "EReferralConsent",
    "title": "Consent",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Consent",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Consent.meta",
                "path": "Consent.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Consent.meta.profile",
                "path": "Consent.meta.profile",
                "comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Consent|1.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",
                "mustSupport": true
            },
            {
                "id": "Consent.identifier.system",
                "path": "Consent.identifier.system",
                "mustSupport": true
            },
            {
                "id": "Consent.identifier.value",
                "path": "Consent.identifier.value",
                "mustSupport": true
            },
            {
                "id": "Consent.status",
                "path": "Consent.status",
                "fixedCode": "active",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/consent-state-codes"
                }
            },
            {
                "id": "Consent.scope",
                "path": "Consent.scope",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding",
                "path": "Consent.scope.coding",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding.system",
                "path": "Consent.scope.coding.system",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding.code",
                "path": "Consent.scope.coding.code",
                "mustSupport": true
            },
            {
                "id": "Consent.scope.coding.display",
                "path": "Consent.scope.coding.display",
                "mustSupport": true
            },
            {
                "id": "Consent.category",
                "path": "Consent.category",
                "mustSupport": true
            },
            {
                "id": "Consent.category.coding",
                "path": "Consent.category.coding",
                "mustSupport": true
            },
            {
                "id": "Consent.category.coding.system",
                "path": "Consent.category.coding.system",
                "mustSupport": true
            },
            {
                "id": "Consent.category.coding.code",
                "path": "Consent.category.coding.code",
                "mustSupport": true
            },
            {
                "id": "Consent.category.coding.display",
                "path": "Consent.category.coding.display",
                "mustSupport": true
            },
            {
                "id": "Consent.patient",
                "path": "Consent.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Patient"
                        ],
                        "aggregation":  [
                            "referenced"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Consent.patient.reference",
                "path": "Consent.patient.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Consent.dateTime",
                "path": "Consent.dateTime",
                "mustSupport": true
            },
            {
                "id": "Consent.performer",
                "path": "Consent.performer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-PractitionerRole"
                        ],
                        "aggregation":  [
                            "referenced"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Consent.performer.reference",
                "path": "Consent.performer.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Consent.organization",
                "path": "Consent.organization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Consent.organization.reference",
                "path": "Consent.organization.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Consent.provision",
                "path": "Consent.provision",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Consent.provision.type",
                "path": "Consent.provision.type",
                "fixedCode": "permit",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.period",
                "path": "Consent.provision.period",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.period.start",
                "path": "Consent.provision.period.start",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.period.end",
                "path": "Consent.provision.period.end",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor",
                "path": "Consent.provision.actor",
                "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",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role.coding.system",
                "path": "Consent.provision.actor.role.coding.system",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role.coding.code",
                "path": "Consent.provision.actor.role.coding.code",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.role.coding.display",
                "path": "Consent.provision.actor.role.coding.display",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.actor.reference",
                "path": "Consent.provision.actor.reference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-PractitionerRole"
                        ],
                        "aggregation":  [
                            "referenced"
                        ]
                    }
                ]
            },
            {
                "id": "Consent.provision.actor.reference.reference",
                "path": "Consent.provision.actor.reference.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Consent.provision.action",
                "path": "Consent.provision.action",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.action.coding",
                "path": "Consent.provision.action.coding",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.action.coding.system",
                "path": "Consent.provision.action.coding.system",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.action.coding.code",
                "path": "Consent.provision.action.coding.code",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.action.coding.display",
                "path": "Consent.provision.action.coding.display",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel",
                "path": "Consent.provision.securityLabel",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel.system",
                "path": "Consent.provision.securityLabel.system",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel.code",
                "path": "Consent.provision.securityLabel.code",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.securityLabel.display",
                "path": "Consent.provision.securityLabel.display",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.purpose",
                "path": "Consent.provision.purpose",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.purpose.system",
                "path": "Consent.provision.purpose.system",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.purpose.code",
                "path": "Consent.provision.purpose.code",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.purpose.display",
                "path": "Consent.provision.purpose.display",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.class",
                "path": "Consent.provision.class",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.class.system",
                "path": "Consent.provision.class.system",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.class.code",
                "path": "Consent.provision.class.code",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.class.display",
                "path": "Consent.provision.class.display",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.data",
                "path": "Consent.provision.data",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.data.meaning",
                "path": "Consent.provision.data.meaning",
                "mustSupport": true
            },
            {
                "id": "Consent.provision.data.reference",
                "path": "Consent.provision.data.reference",
                "mustSupport": true
            }
        ]
    }
}

Usage

The Consent Resource is used to attach supporting information to a ServiceRequest.

Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

.meta.profile

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