Release 5 Preview #3
Security and PrivacyThis page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
| Community Based Collaborative Care Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for consent
{
"resourceType" : "StructureDefinition",
"id" : "Consent",
"meta" : {
"lastUpdated" : "2020-08-20T17:41:31.970+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Security"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "patient"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cbcc"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/Consent",
"version" : "4.5.0",
"name" : "Consent",
"status" : "draft",
"date" : "2020-08-20T17:41:31+10:00",
"publisher" : "Health Level Seven International (Community Based Collaborative Care)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/homehealth/index.cfm"
}]
}],
"description" : "A record of a healthcare consumer’s choices or choices made on their behalf by a third party, 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.",
"fhirVersion" : "4.5.0",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "Consent",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "Consent",
"path" : "Consent",
"short" : "A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time",
"definition" : "A record of a healthcare consumer’s choices or choices made on their behalf by a third party, 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.",
"comment" : "Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "ppc-1",
"severity" : "error",
"human" : "IF Scope=privacy, Consent.subject must be a patient",
"expression" : "(scope = 'privacy' and subject.resolve().exists()) implies (subject.resolve() is Patient)",
"xpath" : "(exists(f:subject) and (f:subject/f:Reference/@value='Patient'])) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='patient-privacy'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"key" : "ppc-2",
"severity" : "error",
"human" : "IF Scope=research, Consent.subject must be a patient",
"expression" : "(scope = 'research' and subject.resolve().exists()) implies (subject.resolve() is Patient)",
"xpath" : "(exists(f:subject) and (f:subject/f:Reference/@value='Patient'])) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='research'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"key" : "ppc-3",
"severity" : "error",
"human" : "IF Scope=treatment, Consent.subject must be a patient",
"expression" : "(scope = 'treatment' and subject.resolve().exists()) implies (subject.resolve() is Patient)",
"xpath" : "(exists(f:subject) and (f:subject/f:Reference/@value='Patient'])) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='treatment'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"key" : "ppc-4",
"severity" : "error",
"human" : "IF Scope=research, ResearchStudyContext allowed",
"expression" : "Consent.provision.extension(\"http://hl7.org/fhir/StructureDefinition/consent-ResearchStudyContext\").exists() or scope.coding.where(system='something' and code='research').exists().not()",
"xpath" : "exists(f:Consent.provision.extension('http://hl7.org/fhir/StructureDefinition/consent-ResearchStudyContext') or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='research'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "CON"
}]
},
{
"id" : "Consent.id",
"path" : "Consent.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.meta",
"path" : "Consent.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.implicitRules",
"path" : "Consent.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Consent.language",
"path" : "Consent.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Consent.text",
"path" : "Consent.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "Consent.contained",
"path" : "Consent.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.extension",
"path" : "Consent.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.modifierExtension",
"path" : "Consent.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.identifier",
"path" : "Consent.identifier",
"short" : "Identifier for this record (external references)",
"definition" : "Unique identifier for this copy of the Consent Statement.",
"comment" : "This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "CON-4 (Consent Form Number – EI)\nNote: An implementation-specific requirement will be needed"
}]
},
{
"id" : "Consent.status",
"path" : "Consent.status",
"short" : "draft | active | inactive | entered-in-error | unknown",
"definition" : "Indicates the current state of this Consent resource.",
"comment" : "This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentState"
}],
"strength" : "required",
"description" : "Indicates the state of the consent.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-state-codes|4.5.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "CON-11 (Consent Status – CNE using table HL70498)"
}]
},
{
"id" : "Consent.scope",
"path" : "Consent.scope",
"short" : "Which of the three areas this resource covers (extensible)",
"definition" : "A selector of the type of consent being presented with the base being Privacy, Treatment, or Research.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.scope",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : true,
"isModifierReason" : "Allows changes to codes based on scope selection",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentScope"
}],
"strength" : "extensible",
"description" : "The four anticipated uses for the Consent Resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-scope"
},
"mapping" : [{
"identity" : "v2",
"map" : "CON-2 (Consent Type - CWE using table HL70496)\nNote: Scope can be derived from category if going from V2 to FHIR."
}]
},
{
"id" : "Consent.category",
"path" : "Consent.category",
"short" : "Classification of the consent statement - for indexing/retrieval",
"definition" : "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Consent.category",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentCategory"
}],
"strength" : "extensible",
"description" : "A classification of the type of consents found in a consent statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-category"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "CON-2 (Consent Type - CWE using table HL70496)"
}]
},
{
"id" : "Consent.subject",
"path" : "Consent.subject",
"short" : "Who the consent applies to",
"definition" : "The patient/healthcare practitioner to whom this consent applies.",
"comment" : "Commonly, the subject the consent pertains to is the author, but for young and old people, it may be some other person.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.subject",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.patient"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Consent.dateTime",
"path" : "Consent.dateTime",
"short" : "When consent was agreed to",
"definition" : "Date and time the consent instance was agreed to.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.dateTime",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "CON-13 (Consent Decision Date/Time – DTM)"
}]
},
{
"id" : "Consent.performer",
"path" : "Consent.performer",
"short" : "Who is agreeing to the policy and rules",
"definition" : "Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.",
"comment" : "Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. Where HealthCareService is listed, some services might not be appropriate based on the type of service and if they can be segmented as an independent or dependent individual entity that might not be eligible to be a grantee.\n\nA Consent without a listed performer may be used as a statement of preference by the subject and is not in force.",
"alias" : ["consentor"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.performer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "CON-24 (Consenter ID) and CON-25 (Relationship to Subject)\nNote, CON-25 is depending on the type of resource being referenced (a reference to a Patient equates to a relationship of 1 (self), a RelatedPerson equates to 2 or 3 depending on RelatedPerson.relationship, etc)"
}]
},
{
"id" : "Consent.manager",
"path" : "Consent.manager",
"short" : "Consent workflow management",
"definition" : "The actor that manages the consent through its lifecycle.",
"alias" : ["manager"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.manager",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "Consent.controller",
"path" : "Consent.controller",
"short" : "Consent Enforcer",
"definition" : "The actor that controls/enforces the access according to the consent.",
"alias" : ["controller"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.controller",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.sourceAttachment",
"path" : "Consent.sourceAttachment",
"short" : "Source from which this consent is taken",
"definition" : "The source on which this consent statement is based. The source might be a scanned original paper form.",
"comment" : "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.sourceAttachment",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Attachment"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "Potential mappings to CON-5,6,7,8,16,19, 20-23"
}]
},
{
"id" : "Consent.sourceReference",
"path" : "Consent.sourceReference",
"short" : "Source from which this consent is taken",
"definition" : "A reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.",
"comment" : "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.sourceReference",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Consent",
"http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/Contract",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "Potential mappings to CON-5,6,7,8,16,19, 20-23"
}]
},
{
"id" : "Consent.policy",
"path" : "Consent.policy",
"short" : "Policies covered by this consent",
"definition" : "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.",
"comment" : "if policy and policyRule are not present, the resource must include the policy being agreed to, or complied with, and that policy and/or policyRule SHOULD be populated as soon as is practical to support workflows that require computability. In addition, the policy could be indicated via the sourceReference or sourceAttachment content.\n\nAlternately, creating an invariant for individual scopes that forces one or more of the elements to be populated as part of a profile or Implementation Guide may be advisable.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.policy",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "CON-3 (Consent Form ID and Version – ST)\nNote: An implementation-specific requirement will be needed"
}]
},
{
"id" : "Consent.policy.id",
"path" : "Consent.policy.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.policy.extension",
"path" : "Consent.policy.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.policy.modifierExtension",
"path" : "Consent.policy.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.policy.authority",
"path" : "Consent.policy.authority",
"short" : "Enforcement source for policy",
"definition" : "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.policy.authority",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"condition" : ["ppc-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.policy.uri",
"path" : "Consent.policy.uri",
"short" : "Specific policy covered by this consent",
"definition" : "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.",
"comment" : "This element is for discoverability / documentation and does not modify or qualify the policy rules.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.policy.uri",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"condition" : ["ppc-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.policyRule",
"path" : "Consent.policyRule",
"short" : "Regulation that this consents to",
"definition" : "A reference to the specific base computable regulation or policy.",
"comment" : "If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource.",
"requirements" : "Might be a unique identifier of a policy set in XACML, or other rules engine.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.policyRule",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["ppc-1"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentPolicyRule"
}],
"strength" : "extensible",
"description" : "Regulatory policy examples.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-policy"
},
"mapping" : [{
"identity" : "v2",
"map" : "CON-3 (Consent Form ID and Version – ST)\nNote: An implementation-specific requirement will be needed"
}]
},
{
"id" : "Consent.verification",
"path" : "Consent.verification",
"short" : "Consent Verified by patient or family",
"definition" : "Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.verification",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.verification.id",
"path" : "Consent.verification.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.verification.extension",
"path" : "Consent.verification.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.verification.modifierExtension",
"path" : "Consent.verification.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.verification.verified",
"path" : "Consent.verification.verified",
"short" : "Has been verified",
"definition" : "Has the instruction been verified.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.verification.verified",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.verification.verificationType",
"path" : "Consent.verification.verificationType",
"short" : "Business case of verification",
"definition" : "Extensible list of verification type starting with verification and re-validation.",
"comment" : "This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.verification.verificationType",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentVerificationType"
}],
"strength" : "extensible",
"description" : "Types of Verification/Validation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-verification"
}
},
{
"id" : "Consent.verification.verifiedBy",
"path" : "Consent.verification.verifiedBy",
"short" : "Person conducting verification",
"definition" : "The person who conducted the verification/validation of the Grantee decision.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.verification.verifiedBy",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.verification.verifiedWith",
"path" : "Consent.verification.verifiedWith",
"short" : "Person who verified",
"definition" : "Who verified the instruction (Patient, Relative or other Authorized Person).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.verification.verifiedWith",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.verification.verificationDate",
"path" : "Consent.verification.verificationDate",
"short" : "When consent verified",
"definition" : "Date(s) verification was collected.",
"comment" : "Allows for history of verification/validation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.verification.verificationDate",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.provision",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "provision"
}],
"path" : "Consent.provision",
"short" : "Constraints to the base Consent.policyRule/Consent.policy",
"definition" : "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.provision",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.provision.id",
"path" : "Consent.provision.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.provision.extension",
"path" : "Consent.provision.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.provision.modifierExtension",
"path" : "Consent.provision.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.provision.type",
"path" : "Consent.provision.type",
"short" : "deny | permit",
"definition" : "Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.provision.type",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentProvisionType"
}],
"strength" : "required",
"description" : "How a rule statement is applied, such as adding additional consent or removing consent.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-provision-type|4.5.0"
}
},
{
"id" : "Consent.provision.period",
"path" : "Consent.provision.period",
"short" : "Timeframe for this rule",
"definition" : "The timeframe in this rule is valid.",
"comment" : "This is the bound effective time of the consent and should be in the base provision in the Consent resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.provision.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "CON-14&15 (Consent Effective Date Time, Consent End DateTime)"
}]
},
{
"id" : "Consent.provision.actor",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "provisionActor"
}],
"path" : "Consent.provision.actor",
"short" : "Who|what controlled by this rule (or group, by role)",
"definition" : "Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.actor",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "There is no specific actor associated with the exception",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.provision.actor.id",
"path" : "Consent.provision.actor.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.provision.actor.extension",
"path" : "Consent.provision.actor.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.provision.actor.modifierExtension",
"path" : "Consent.provision.actor.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.provision.actor.role",
"path" : "Consent.provision.actor.role",
"short" : "How the actor is involved",
"definition" : "How the individual is involved in the resources content that is described in the exception.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.provision.actor.role",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentActorRole"
}],
"strength" : "extensible",
"description" : "How an actor is involved in the consent considerations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
{
"id" : "Consent.provision.actor.reference",
"path" : "Consent.provision.actor.reference",
"short" : "Resource for the actor (or group, by role)",
"definition" : "The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.provision.actor.reference",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Consent.provision.action",
"path" : "Consent.provision.action",
"short" : "Actions controlled by this rule",
"definition" : "Actions controlled by this Rule.",
"comment" : "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.action",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"meaningWhenMissing" : "all actions",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentAction"
}],
"strength" : "example",
"description" : "Detailed codes for the consent action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-action"
}
},
{
"id" : "Consent.provision.securityLabel",
"path" : "Consent.provision.securityLabel",
"short" : "Security Labels that define affected resources",
"definition" : "A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.",
"comment" : "If the consent specifies a security label of \"R\" then it applies to all resources that are labeled \"R\" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.securityLabel",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SecurityLabels"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-labels"
}
},
{
"id" : "Consent.provision.purpose",
"path" : "Consent.provision.purpose",
"short" : "Context of activities covered by this rule",
"definition" : "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.",
"comment" : "When the purpose of use tag is on the data, access request purpose of use shall not conflict.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.purpose",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PurposeOfUse"
}],
"strength" : "extensible",
"description" : "What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
}
},
{
"id" : "Consent.provision.class",
"path" : "Consent.provision.class",
"short" : "e.g. Resource Type, Profile, CDA, etc.",
"definition" : "The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.",
"comment" : "Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.class",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Coding"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentContentClass"
}],
"strength" : "extensible",
"description" : "The class (type) of information a consent rule covers.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-content-class"
}
},
{
"id" : "Consent.provision.code",
"path" : "Consent.provision.code",
"short" : "e.g. LOINC or SNOMED CT code, etc. in the content",
"definition" : "If this code is found in an instance, then the rule applies.",
"comment" : "Typical use of this is a Document code with class = CDA.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.code",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentContentCode"
}],
"strength" : "example",
"description" : "If this code is found in an instance, then the exception applies.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-content-code"
}
},
{
"id" : "Consent.provision.dataPeriod",
"path" : "Consent.provision.dataPeriod",
"short" : "Timeframe for data controlled by this rule",
"definition" : "Clinical or Operational Relevant period of time that bounds the data controlled by this rule.",
"comment" : "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.provision.dataPeriod",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.provision.data",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "provisionData"
}],
"path" : "Consent.provision.data",
"short" : "Data controlled by this rule",
"definition" : "The resources controlled by this rule if specific resources are referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.data",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "all data",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.provision.data.id",
"path" : "Consent.provision.data.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.provision.data.extension",
"path" : "Consent.provision.data.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "Consent.provision.data.modifierExtension",
"path" : "Consent.provision.data.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "Consent.provision.data.meaning",
"path" : "Consent.provision.data.meaning",
"short" : "instance | related | dependents | authoredby",
"definition" : "How the resource reference is interpreted when testing consent restrictions.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.provision.data.meaning",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentDataMeaning"
}],
"strength" : "required",
"description" : "How a resource reference is interpreted when testing consent restrictions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-data-meaning|4.5.0"
}
},
{
"id" : "Consent.provision.data.reference",
"path" : "Consent.provision.data.reference",
"short" : "The actual data reference",
"definition" : "A reference to a specific resource that defines which resources are covered by this consent.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.provision.data.reference",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Consent.provision.provision",
"path" : "Consent.provision.provision",
"short" : "Nested Exception Rules",
"definition" : "Rules which provide exceptions to the base rule or subrules.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.provision.provision",
"min" : 0,
"max" : "*"
},
"contentReference" : "#Consent.provision",
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential" : {
"element" : [{
"id" : "Consent",
"path" : "Consent",
"short" : "A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time",
"definition" : "A record of a healthcare consumer’s choices or choices made on their behalf by a third party, 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.",
"comment" : "Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "ppc-4",
"severity" : "error",
"human" : "IF Scope=research, ResearchStudyContext allowed",
"expression" : "Consent.provision.extension(\"http://hl7.org/fhir/StructureDefinition/consent-ResearchStudyContext\").exists() or scope.coding.where(system='something' and code='research').exists().not()",
"xpath" : "exists(f:Consent.provision.extension('http://hl7.org/fhir/StructureDefinition/consent-ResearchStudyContext') or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='research'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"key" : "ppc-2",
"severity" : "error",
"human" : "IF Scope=research, Consent.subject must be a patient",
"expression" : "(scope = 'research' and subject.resolve().exists()) implies (subject.resolve() is Patient)",
"xpath" : "(exists(f:subject) and (f:subject/f:Reference/@value='Patient'])) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='research'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"key" : "ppc-3",
"severity" : "error",
"human" : "IF Scope=treatment, Consent.subject must be a patient",
"expression" : "(scope = 'treatment' and subject.resolve().exists()) implies (subject.resolve() is Patient)",
"xpath" : "(exists(f:subject) and (f:subject/f:Reference/@value='Patient'])) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='treatment'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"key" : "ppc-1",
"severity" : "error",
"human" : "IF Scope=privacy, Consent.subject must be a patient",
"expression" : "(scope = 'privacy' and subject.resolve().exists()) implies (subject.resolve() is Patient)",
"xpath" : "(exists(f:subject) and (f:subject/f:Reference/@value='Patient'])) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='patient-privacy'])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Consent"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "v2",
"map" : "CON"
}]
},
{
"id" : "Consent.identifier",
"path" : "Consent.identifier",
"short" : "Identifier for this record (external references)",
"definition" : "Unique identifier for this copy of the Consent Statement.",
"comment" : "This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "CON-4 (Consent Form Number – EI)\nNote: An implementation-specific requirement will be needed"
}]
},
{
"id" : "Consent.status",
"path" : "Consent.status",
"short" : "draft | active | inactive | entered-in-error | unknown",
"definition" : "Indicates the current state of this Consent resource.",
"comment" : "This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentState"
}],
"strength" : "required",
"description" : "Indicates the state of the consent.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-state-codes|4.5.0"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "CON-11 (Consent Status – CNE using table HL70498)"
}]
},
{
"id" : "Consent.scope",
"path" : "Consent.scope",
"short" : "Which of the three areas this resource covers (extensible)",
"definition" : "A selector of the type of consent being presented with the base being Privacy, Treatment, or Research.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : true,
"isModifierReason" : "Allows changes to codes based on scope selection",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentScope"
}],
"strength" : "extensible",
"description" : "The four anticipated uses for the Consent Resource.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-scope"
},
"mapping" : [{
"identity" : "v2",
"map" : "CON-2 (Consent Type - CWE using table HL70496)\nNote: Scope can be derived from category if going from V2 to FHIR."
}]
},
{
"id" : "Consent.category",
"path" : "Consent.category",
"short" : "Classification of the consent statement - for indexing/retrieval",
"definition" : "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.",
"min" : 1,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentCategory"
}],
"strength" : "extensible",
"description" : "A classification of the type of consents found in a consent statement.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-category"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "CON-2 (Consent Type - CWE using table HL70496)"
}]
},
{
"id" : "Consent.subject",
"path" : "Consent.subject",
"short" : "Who the consent applies to",
"definition" : "The patient/healthcare practitioner to whom this consent applies.",
"comment" : "Commonly, the subject the consent pertains to is the author, but for young and old people, it may be some other person.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.patient"
},
{
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Consent.dateTime",
"path" : "Consent.dateTime",
"short" : "When consent was agreed to",
"definition" : "Date and time the consent instance was agreed to.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"identity" : "v2",
"map" : "CON-13 (Consent Decision Date/Time – DTM)"
}]
},
{
"id" : "Consent.performer",
"path" : "Consent.performer",
"short" : "Who is agreeing to the policy and rules",
"definition" : "Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.",
"comment" : "Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. Where HealthCareService is listed, some services might not be appropriate based on the type of service and if they can be segmented as an independent or dependent individual entity that might not be eligible to be a grantee.\n\nA Consent without a listed performer may be used as a statement of preference by the subject and is not in force.",
"alias" : ["consentor"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer.actor"
},
{
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"identity" : "v2",
"map" : "CON-24 (Consenter ID) and CON-25 (Relationship to Subject)\nNote, CON-25 is depending on the type of resource being referenced (a reference to a Patient equates to a relationship of 1 (self), a RelatedPerson equates to 2 or 3 depending on RelatedPerson.relationship, etc)"
}]
},
{
"id" : "Consent.manager",
"path" : "Consent.manager",
"short" : "Consent workflow management",
"definition" : "The actor that manages the consent through its lifecycle.",
"alias" : ["manager"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}],
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "Consent.controller",
"path" : "Consent.controller",
"short" : "Consent Enforcer",
"definition" : "The actor that controls/enforces the access according to the consent.",
"alias" : ["controller"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner"]
}]
},
{
"id" : "Consent.sourceAttachment",
"path" : "Consent.sourceAttachment",
"short" : "Source from which this consent is taken",
"definition" : "The source on which this consent statement is based. The source might be a scanned original paper form.",
"comment" : "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Attachment"
}],
"mapping" : [{
"identity" : "v2",
"map" : "Potential mappings to CON-5,6,7,8,16,19, 20-23"
}]
},
{
"id" : "Consent.sourceReference",
"path" : "Consent.sourceReference",
"short" : "Source from which this consent is taken",
"definition" : "A reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.",
"comment" : "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Consent",
"http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/Contract",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"]
}],
"mapping" : [{
"identity" : "v2",
"map" : "Potential mappings to CON-5,6,7,8,16,19, 20-23"
}]
},
{
"id" : "Consent.policy",
"path" : "Consent.policy",
"short" : "Policies covered by this consent",
"definition" : "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.",
"comment" : "if policy and policyRule are not present, the resource must include the policy being agreed to, or complied with, and that policy and/or policyRule SHOULD be populated as soon as is practical to support workflows that require computability. In addition, the policy could be indicated via the sourceReference or sourceAttachment content.\n\nAlternately, creating an invariant for individual scopes that forces one or more of the elements to be populated as part of a profile or Implementation Guide may be advisable.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mapping" : [{
"identity" : "v2",
"map" : "CON-3 (Consent Form ID and Version – ST)\nNote: An implementation-specific requirement will be needed"
}]
},
{
"id" : "Consent.policy.authority",
"path" : "Consent.policy.authority",
"short" : "Enforcement source for policy",
"definition" : "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"condition" : ["ppc-1"]
},
{
"id" : "Consent.policy.uri",
"path" : "Consent.policy.uri",
"short" : "Specific policy covered by this consent",
"definition" : "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.",
"comment" : "This element is for discoverability / documentation and does not modify or qualify the policy rules.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "uri"
}],
"condition" : ["ppc-1"]
},
{
"id" : "Consent.policyRule",
"path" : "Consent.policyRule",
"short" : "Regulation that this consents to",
"definition" : "A reference to the specific base computable regulation or policy.",
"comment" : "If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource.",
"requirements" : "Might be a unique identifier of a policy set in XACML, or other rules engine.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"condition" : ["ppc-1"],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentPolicyRule"
}],
"strength" : "extensible",
"description" : "Regulatory policy examples.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-policy"
},
"mapping" : [{
"identity" : "v2",
"map" : "CON-3 (Consent Form ID and Version – ST)\nNote: An implementation-specific requirement will be needed"
}]
},
{
"id" : "Consent.verification",
"path" : "Consent.verification",
"short" : "Consent Verified by patient or family",
"definition" : "Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "Consent.verification.verified",
"path" : "Consent.verification.verified",
"short" : "Has been verified",
"definition" : "Has the instruction been verified.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "boolean"
}],
"isSummary" : true
},
{
"id" : "Consent.verification.verificationType",
"path" : "Consent.verification.verificationType",
"short" : "Business case of verification",
"definition" : "Extensible list of verification type starting with verification and re-validation.",
"comment" : "This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentVerificationType"
}],
"strength" : "extensible",
"description" : "Types of Verification/Validation.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-verification"
}
},
{
"id" : "Consent.verification.verifiedBy",
"path" : "Consent.verification.verifiedBy",
"short" : "Person conducting verification",
"definition" : "The person who conducted the verification/validation of the Grantee decision.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}]
},
{
"id" : "Consent.verification.verifiedWith",
"path" : "Consent.verification.verifiedWith",
"short" : "Person who verified",
"definition" : "Who verified the instruction (Patient, Relative or other Authorized Person).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"]
}]
},
{
"id" : "Consent.verification.verificationDate",
"path" : "Consent.verification.verificationDate",
"short" : "When consent verified",
"definition" : "Date(s) verification was collected.",
"comment" : "Allows for history of verification/validation.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "dateTime"
}]
},
{
"id" : "Consent.provision",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "provision"
}],
"path" : "Consent.provision",
"short" : "Constraints to the base Consent.policyRule/Consent.policy",
"definition" : "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"isSummary" : true
},
{
"id" : "Consent.provision.type",
"path" : "Consent.provision.type",
"short" : "deny | permit",
"definition" : "Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentProvisionType"
}],
"strength" : "required",
"description" : "How a rule statement is applied, such as adding additional consent or removing consent.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-provision-type|4.5.0"
}
},
{
"id" : "Consent.provision.period",
"path" : "Consent.provision.period",
"short" : "Timeframe for this rule",
"definition" : "The timeframe in this rule is valid.",
"comment" : "This is the bound effective time of the consent and should be in the base provision in the Consent resource.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "CON-14&15 (Consent Effective Date Time, Consent End DateTime)"
}]
},
{
"id" : "Consent.provision.actor",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "provisionActor"
}],
"path" : "Consent.provision.actor",
"short" : "Who|what controlled by this rule (or group, by role)",
"definition" : "Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "There is no specific actor associated with the exception"
},
{
"id" : "Consent.provision.actor.role",
"path" : "Consent.provision.actor.role",
"short" : "How the actor is involved",
"definition" : "How the individual is involved in the resources content that is described in the exception.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentActorRole"
}],
"strength" : "extensible",
"description" : "How an actor is involved in the consent considerations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
{
"id" : "Consent.provision.actor.reference",
"path" : "Consent.provision.actor.reference",
"short" : "Resource for the actor (or group, by role)",
"definition" : "The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Group",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"]
}]
},
{
"id" : "Consent.provision.action",
"path" : "Consent.provision.action",
"short" : "Actions controlled by this rule",
"definition" : "Actions controlled by this Rule.",
"comment" : "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"meaningWhenMissing" : "all actions",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentAction"
}],
"strength" : "example",
"description" : "Detailed codes for the consent action.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-action"
}
},
{
"id" : "Consent.provision.securityLabel",
"path" : "Consent.provision.securityLabel",
"short" : "Security Labels that define affected resources",
"definition" : "A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.",
"comment" : "If the consent specifies a security label of \"R\" then it applies to all resources that are labeled \"R\" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "SecurityLabels"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "extensible",
"description" : "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet" : "http://hl7.org/fhir/ValueSet/security-labels"
}
},
{
"id" : "Consent.provision.purpose",
"path" : "Consent.provision.purpose",
"short" : "Context of activities covered by this rule",
"definition" : "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.",
"comment" : "When the purpose of use tag is on the data, access request purpose of use shall not conflict.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PurposeOfUse"
}],
"strength" : "extensible",
"description" : "What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse"
}
},
{
"id" : "Consent.provision.class",
"path" : "Consent.provision.class",
"short" : "e.g. Resource Type, Profile, CDA, etc.",
"definition" : "The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.",
"comment" : "Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Coding"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentContentClass"
}],
"strength" : "extensible",
"description" : "The class (type) of information a consent rule covers.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-content-class"
}
},
{
"id" : "Consent.provision.code",
"path" : "Consent.provision.code",
"short" : "e.g. LOINC or SNOMED CT code, etc. in the content",
"definition" : "If this code is found in an instance, then the rule applies.",
"comment" : "Typical use of this is a Document code with class = CDA.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentContentCode"
}],
"strength" : "example",
"description" : "If this code is found in an instance, then the exception applies.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-content-code"
}
},
{
"id" : "Consent.provision.dataPeriod",
"path" : "Consent.provision.dataPeriod",
"short" : "Timeframe for data controlled by this rule",
"definition" : "Clinical or Operational Relevant period of time that bounds the data controlled by this rule.",
"comment" : "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
},
{
"id" : "Consent.provision.data",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "provisionData"
}],
"path" : "Consent.provision.data",
"short" : "Data controlled by this rule",
"definition" : "The resources controlled by this rule if specific resources are referenced.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"meaningWhenMissing" : "all data",
"isSummary" : true
},
{
"id" : "Consent.provision.data.meaning",
"path" : "Consent.provision.data.meaning",
"short" : "instance | related | dependents | authoredby",
"definition" : "How the resource reference is interpreted when testing consent restrictions.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ConsentDataMeaning"
}],
"strength" : "required",
"description" : "How a resource reference is interpreted when testing consent restrictions.",
"valueSet" : "http://hl7.org/fhir/ValueSet/consent-data-meaning|4.5.0"
}
},
{
"id" : "Consent.provision.data.reference",
"path" : "Consent.provision.data.reference",
"short" : "The actual data reference",
"definition" : "A reference to a specific resource that defines which resources are covered by this consent.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"]
}],
"isSummary" : true
},
{
"id" : "Consent.provision.provision",
"path" : "Consent.provision.provision",
"short" : "Nested Exception Rules",
"definition" : "Rules which provide exceptions to the base rule or subrules.",
"min" : 0,
"max" : "*",
"contentReference" : "#Consent.provision"
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:45+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change