FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

6.2.19 Resource Consent - Search Parameters

Community Based Collaborative Care icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Patient Compartments: Group, Patient

Search parameters for the Consent 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

Generated Narrative: SearchParameter Consent-action

6.2.20 action

Parameter action:token

LOINC or SNOMED CT code, etc. in the content

ResourceConsent
Expression Consent.provision.code
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-actor

6.2.21 actor

Parameter actor:reference

Resource for the actor (or group, by role)

ResourceConsent
Expression Consent.provision.actor.reference
Processing Mode Normal
Target Resources Device, CareTeam, Organization, RelatedPerson, PractitionerRole, Group, Practitioner, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-category

6.2.22 category

Parameter category:token

Classification of the consent statement - for indexing/retrieval

ResourceConsent
Expression Consent.category
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-controller

6.2.23 controller

Parameter controller:reference

Consent Enforcer

ResourceConsent
Expression Consent.controller
Processing Mode Normal
Target Resources HealthcareService, Organization, Practitioner, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-data

6.2.24 data

Parameter data:reference

The actual data reference

ResourceConsent
Expression Consent.provision.data.reference
Processing Mode Normal
Target Resources All Resources
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter clinical-date

6.2.25 date

Parameter date:date

Consent: When consent was agreed to

ResourceConsent
Expression Consent.date
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-grantee

6.2.26 grantee

Parameter grantee:reference

Who is agreeing to the policy and rules

ResourceConsent
Expression Consent.grantee
Processing Mode Normal
Target Resources HealthcareService, CareTeam, Organization, RelatedPerson, PractitionerRole, Group, Practitioner, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter clinical-identifier

6.2.27 identifier

Parameter identifier:token

Consent: Identifier for this record (external references)

ResourceConsent
Expression Consent.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-manager

6.2.28 manager

Parameter manager:reference

Consent workflow management

ResourceConsent
Expression Consent.manager
Processing Mode Normal
Target Resources HealthcareService, Organization, Practitioner, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter clinical-patient

6.2.29 patient

Parameter patient:reference

Consent: Who the consent applies to

ResourceConsent
Expression Consent.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-period

6.2.30 period

Parameter period:date

Timeframe for this rule

ResourceConsent
Expression Consent.provision.period
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-purpose

6.2.31 purpose

Parameter purpose:token

Context of activities covered by this rule

ResourceConsent
Expression Consent.provision.purpose
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-security-label

6.2.32 security-label

Parameter security-label:token

Security Labels that define affected resources

ResourceConsent
Expression Consent.provision.securityLabel
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

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

ResourceConsent
Expression Consent.sourceReference
Processing Mode Normal
Target Resources Consent, DocumentReference, Contract, QuestionnaireResponse
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-status

6.2.34 status

Parameter status:token

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

ResourceConsent
Expression Consent.status
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-subject

6.2.35 subject

Parameter subject:reference

Who the consent applies to

ResourceConsent
Expression Consent.subject
Processing Mode Normal
Target Resources ResearchSubject, Practitioner, Group, Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-verified

6.2.36 verified

Parameter verified:token

Has been verified

ResourceConsent
Expression Consent.verification.verified
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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

Generated Narrative: SearchParameter Consent-verified-date

6.2.37 verified-date

Parameter verified-date:date

When consent verified

ResourceConsent
Expression Consent.verification.verificationDate
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat 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