Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

6.2.20 6.2.19 Resource Consent - Search Parameters

Maturity Level : N/A
Responsible Owner: Community Based Collaborative Care icon Work Group   Trial Use Normative Security Category : Patient Compartments : Group , Patient

Search parameters for the Resource Consent - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to 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 Generated Narrative: SearchParameter Consent-action

6.2.20 action

Parameter action : token

Actions controlled by this rule LOINC or SNOMED CT code, etc. in the content

Resource Consent
Expression Consent.provision.action Consent.repeat(provision).code
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-actor

6.2.22 Generated Narrative: SearchParameter Consent-actor

6.2.21 actor

Parameter actor : reference

Resource for the actor (or group, by role)

Resource Consent
Expression Consent.provision.actor.reference Consent.repeat(provision).actor.reference
Processing Mode Normal
Target Resources Device , CareTeam , Organization , RelatedPerson , PractitionerRole , Group , Practitioner , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-category

6.2.23 Generated Narrative: SearchParameter Consent-category

6.2.22 category

Parameter category : token

Classification of the consent statement - for indexing/retrieval

Resource Consent
Expression Consent.category
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-controller

6.2.24 Generated Narrative: SearchParameter Consent-controller

6.2.23 controller

Parameter controller : reference

Consent Enforcer

Resource Consent
Expression Consent.controller
Processing Mode Normal
Target Resources HealthcareService , Organization , Practitioner , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-data

6.2.25 Generated Narrative: SearchParameter Consent-data

6.2.24 data

Parameter data : reference

The actual data reference

Resource Consent
Expression Consent.provision.data.reference Consent.repeat(provision).data.reference
Processing Mode Normal
Target Resources All Resources
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-date
This search parameter is part of the common search parameter clinical-date

6.2.26 Generated Narrative: SearchParameter clinical-date

6.2.25 date TU

Parameter date : date

Consent : When consent was agreed to

Resource Consent
Expression Consent.date
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Consent-grantee

6.2.27 Generated Narrative: SearchParameter Consent-grantee

6.2.26 grantee

Parameter grantee : reference

Who is agreeing to the policy and rules

Resource Consent
Expression Consent.grantee
Processing Mode Normal
Target Resources HealthcareService , CareTeam , Organization , RelatedPerson , PractitionerRole , Group , Practitioner , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

6.2.28 Generated Narrative: SearchParameter clinical-identifier

6.2.27 identifier TU

Parameter identifier : token

Consent : Identifier for this record (external references)

Resource Consent
Expression Consent.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-manager

6.2.29 Generated Narrative: SearchParameter Consent-manager

6.2.28 manager

Parameter manager : reference

Consent workflow management

Resource Consent
Expression Consent.manager
Processing Mode Normal
Target Resources HealthcareService , Organization , Practitioner , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

6.2.30 Generated Narrative: SearchParameter clinical-patient

6.2.29 patient TU

Parameter patient : reference

Consent : Who the consent applies to

Resource Consent
Expression Consent.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-period

6.2.31 Generated Narrative: SearchParameter Consent-period

6.2.30 period

Parameter period : date

Timeframe for this rule

Resource Consent
Expression Consent.provision.period Consent.repeat(provision).period
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Consent-purpose

6.2.32 Generated Narrative: SearchParameter Consent-purpose

6.2.31 purpose

Parameter purpose : token

Context of activities covered by this rule

Resource Consent
Expression Consent.provision.purpose Consent.repeat(provision).purpose
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-security-label

6.2.33 Generated Narrative: SearchParameter Consent-security-label

6.2.32 security-label

Parameter security-label : token

Security Labels that define affected resources

Resource Consent
Expression Consent.provision.securityLabel Consent.repeat(provision).securityLabel
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-source-reference

6.2.34 Generated Narrative: SearchParameter Consent-source-reference

6.2.33 source-reference

Parameter source-reference : reference

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

Resource Consent
Expression Consent.sourceReference
Processing Mode Normal
Target Resources Consent , DocumentReference , Contract , QuestionnaireResponse
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-status

6.2.35 Generated Narrative: SearchParameter Consent-status

6.2.34 status

Parameter status : token

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

Resource Consent
Expression Consent.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-subject

6.2.36 Generated Narrative: SearchParameter Consent-subject

6.2.35 subject

Parameter subject : reference

Who the consent applies to

Resource Consent
Expression Consent.subject
Processing Mode Normal
Target Resources ResearchSubject , Practitioner , Group , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-verified

6.2.37 Generated Narrative: SearchParameter Consent-verified

6.2.36 verified

Parameter verified : token

Has been verified

Resource Consent
Expression Consent.verification.verified
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/Consent-verified-date

6.2.38 Generated Narrative: SearchParameter Consent-verified-date

6.2.37 verified-date

Parameter verified-date : date

When consent verified

Resource Consent
Expression Consent.verification.verificationDate Consent.verification.date
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap