Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

6.2.19 Resource Consent - Search Parameters

Community Based Collaborative Care icon Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Patient Compartments: Patient

Search Parameter Registry for the consent resource

6.2.20 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/Consent-action

6.2.21 action

Parameter action:token

Actions controlled by this rule

ResourceConsent
ExpressionConsent.provision.action
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-actor

6.2.22 actor

Parameter actor:reference

Resource for the actor (or group, by role)

ResourceConsent
ExpressionConsent.provision.actor.reference
Target ResourcesPractitioner, Group, Organization, CareTeam, Device, Patient, PractitionerRole, RelatedPerson
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-category

6.2.23 category

Parameter category:token

Classification of the consent statement - for indexing/retrieval

ResourceConsent
ExpressionConsent.category
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-controller

6.2.24 controller

Parameter controller:reference

Consent Enforcer

ResourceConsent
ExpressionConsent.controller
Target ResourcesPractitioner, Organization, Patient, HealthcareService
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-data

6.2.25 data

Parameter data:reference

The actual data reference

ResourceConsent
ExpressionConsent.provision.data.reference
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Consent-date

6.2.26 date

Parameter date:date

When consent was agreed to

Resources
ExpressionConsent.dateTime
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-grantee

6.2.27 grantee

Parameter grantee:reference

Who is agreeing to the policy and rules

ResourceConsent
ExpressionConsent.grantee
Target ResourcesPractitioner, Organization, CareTeam, Patient, HealthcareService, PractitionerRole, RelatedPerson
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Consent-identifier

6.2.28 identifier

Parameter identifier:token

Identifier for this record (external references)

Resources
ExpressionConsent.identifier
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-manager

6.2.29 manager

Parameter manager:reference

Consent workflow management

ResourceConsent
ExpressionConsent.manager
Target ResourcesPractitioner, Organization, Patient, HealthcareService
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Consent-patient

6.2.30 patient

Parameter patient:reference

Who the consent applies to

Resources
ExpressionConsent.subject.where(resolve() is Patient)
UsageNormal
Target ResourcesPatient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-period

6.2.31 period

Parameter period:date

Timeframe for this rule

ResourceConsent
ExpressionConsent.provision.period
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Consent-purpose

6.2.32 purpose

Parameter purpose:token

Context of activities covered by this rule

ResourceConsent
ExpressionConsent.provision.purpose
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-security-label

6.2.33 security-label

Parameter security-label:token

Security Labels that define affected resources

ResourceConsent
ExpressionConsent.provision.securityLabel
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-source-reference

6.2.34 source-reference

Parameter source-reference:reference

Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse

ResourceConsent
ExpressionConsent.sourceReference
Target ResourcesConsent, Contract, QuestionnaireResponse, DocumentReference
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-status

6.2.35 status

Parameter status:token

draft | active | inactive | entered-in-error | unknown

ResourceConsent
ExpressionConsent.status
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-subject

6.2.36 subject

Parameter subject:reference

Who the consent applies to

ResourceConsent
ExpressionConsent.subject
Target ResourcesPractitioner, Group, Patient
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-verified

6.2.37 verified

Parameter verified:token

Has been verified

ResourceConsent
ExpressionConsent.verification.verified
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Consent-verified-date

6.2.38 verified-date

Parameter verified-date:date

When consent verified

ResourceConsent
ExpressionConsent.verification.verificationDate
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap