Skip to main content

Consent

Trial Use 2 Foundation

A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Consent
InteractionMethodPath
ReadGET/fhir/R4/Consent/[id]
VreadGET/fhir/R4/Consent/[id]/_history/[vid]
UpdatePUT/fhir/R4/Consent/[id]
PatchPATCH/fhir/R4/Consent/[id]
DeleteDELETE/fhir/R4/Consent/[id]
CreatePOST/fhir/R4/Consent
SearchGET/fhir/R4/Consent
HistoryGET/fhir/R4/Consent/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Identifier for this record (external references)
statuscode1..1draft | proposed | active | rejected | inactive | entered-in-error modifier
scopeCodeableConcept1..1Which of the four areas this resource covers (extensible) modifier
categoryCodeableConcept1..*Classification of the consent statement - for indexing/retrieval
patientReference0..1Who the consent applies to
dateTimedateTime0..1When this Consent was created or indexed
performerReference0..*Who is agreeing to the policy and rules
organizationReference0..*Custodian of the consent
source[x]Attachment / Reference0..1Source from which this consent is taken
policyBackboneElement0..*Policies covered by this consent
policyRuleCodeableConcept0..1Regulation that this consents to
verificationBackboneElement0..*Consent Verified by patient or family
provisionBackboneElement0..1Constraints to the base Consent.policyRule

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
actionstringhttp://hl7.org/fhir/SearchParameter/Consent-action
actorstringhttp://hl7.org/fhir/SearchParameter/Consent-actor
categorystringhttp://hl7.org/fhir/SearchParameter/Consent-category
consentorstringhttp://hl7.org/fhir/SearchParameter/Consent-consentor
datastringhttp://hl7.org/fhir/SearchParameter/Consent-data
datestringhttp://hl7.org/fhir/SearchParameter/clinical-date
identifierstringhttp://hl7.org/fhir/SearchParameter/clinical-identifier
organizationstringhttp://hl7.org/fhir/SearchParameter/Consent-organization
patientstringhttp://hl7.org/fhir/SearchParameter/clinical-patient
periodstringhttp://hl7.org/fhir/SearchParameter/Consent-period
purposestringhttp://hl7.org/fhir/SearchParameter/Consent-purpose
scopestringhttp://hl7.org/fhir/SearchParameter/Consent-scope
security-labelstringhttp://hl7.org/fhir/SearchParameter/Consent-security-label
source-referencestringhttp://hl7.org/fhir/SearchParameter/Consent-source-reference
statusstringhttp://hl7.org/fhir/SearchParameter/Consent-status

Reference​

  • Official FHIR R4 spec: Consent
  • Maturity: Trial Use 2 (FMM 2).