Security
and
Privacy
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
R4
R3
| Community Based Collaborative Care Work Group | Maturity Level : N/A |
|
Compartments : Patient |
Raw JSON ( canonical form + also see JSON Format Specification )
StructureDefinition for consent
{
"resourceType": "StructureDefinition",
"id": "Consent",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
"resourceType" : "StructureDefinition",
"id" : "Consent",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cbcc"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Consent",
"name": "Consent",
"status": "draft",
"date": "2019-10-24T11:53:00+11: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/cbcc/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Consent Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 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 policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time",
"definition": "A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.",
"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 general advance care directives.",
"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": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "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": "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",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "ppc-1",
"severity": "error",
"human": "Either a Policy or PolicyRule",
"expression": "policy.exists() or policyRule.exists()",
"xpath": "exists(f:policy) or exists(f:policyRule)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "FinancialConsent"
},
{
"identity": "w5",
"map": "infrastructure.information"
}
]
"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.0.1",
"name" : "Consent",
"status" : "draft",
"date" : "2019-11-01T09:29:23+11: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, 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.0.1",
"mapping" : [{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern 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 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, 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 general advance care directives.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent",
"min" : 0,
"max" : "*"
},
{
"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": [
{
"code": "id"
}
],
"isSummary": true
"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"
},
{
"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 may 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"
}
],
"isSummary": true
"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"
},
{
"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.",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
"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"
},
{
"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"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "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": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
"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"
},
{
"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 may 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 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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
{
"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"
},
{
"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, and 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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"key" : "ppc-1",
"severity" : "error",
"human" : "Either a Policy or PolicyRule",
"expression" : "policy.exists() or policyRule.exists()",
"xpath" : "exists(f:policy) or exists(f:policyRule)"
},
{
"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. In order 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.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"key" : "ppc-2",
"severity" : "error",
"human" : "IF Scope=privacy, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='patient-privacy'])))"
},
{
"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. Usually modifier elements provide negation or qualification. In order 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.",
"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.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"key" : "ppc-3",
"severity" : "error",
"human" : "IF Scope=research, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='research').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='research'])))"
},
{
"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 is 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": "1",
"type": [
{
"code": "Identifier"
}
],
"example": [
{
"label": "General",
"valueIdentifier": {
"system": "urn:ietf:rfc:3986",
"value": "Local eCMS identifier"
}
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
"key" : "ppc-4",
"severity" : "error",
"human" : "IF Scope=adr, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='adr'])))"
},
{
"id": "Consent.status",
"path": "Consent.status",
"short": "draft | proposed | active | rejected | inactive | entered-in-error",
"definition": "Indicates the current state of this consent.",
"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.",
"requirements": "The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentState"
}
],
"strength": "required",
"description": "Indicates the state of the consent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-state-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "HL7 Table 0498 - Consent Status"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
"key" : "ppc-5",
"severity" : "error",
"human" : "IF Scope=treatment, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='treatment'])))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"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": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentCategory"
}
],
"strength": "example",
"description": "A classification of the type of consents found in a consent statement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-category"
}
},
"mapping": [
{
"identity": "rim",
"map": "CNTRCT"
},
{
"identity": "w5",
"map": "class"
}
]
"identity" : "workflow",
"map" : "Event"
},
{
"id": "Consent.patient",
"path": "Consent.patient",
"short": "Who the consent applies to",
"definition": "The patient/healthcare consumer to whom this consent applies.",
"comment": "Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
"identity" : "v2",
"map" : "CON"
},
{
"id": "Consent.period",
"path": "Consent.period",
"short": "Period that this consent applies",
"definition": "Relevant time or time-period when this Consent is applicable.",
"comment": "This can be a subset of the period of the original statement.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"meaningWhenMissing": "all date ranges included",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialConsent activityTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
"identity" : "rim",
"map" : "FinancialConsent"
}]
},
{
"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"
},
{
"id": "Consent.dateTime",
"path": "Consent.dateTime",
"short": "When this Consent was created or indexed",
"definition": "When this Consent was issued / created / indexed.",
"comment": "This is not the time of the original consent, but the time that this statement was made or derived.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialConsent effectiveTime"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"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"
},
{
"id": "Consent.consentingParty",
"path": "Consent.consentingParty",
"short": "Who is agreeing to the policy and exceptions",
"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.",
"alias": [
"consentor"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
"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"
},
{
"id": "Consent.actor",
"path": "Consent.actor",
"short": "Who|what controlled by this consent (or group, by role)",
"definition": "Who or what is controlled by this consent. 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 consent",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
"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"
},
{
"id": "Consent.actor.id",
"path": "Consent.actor.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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" : [{
"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"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Consent.actor.extension",
"path": "Consent.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. In order 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.",
"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": "*"
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
{
"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 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"
},
{
"id": "Consent.actor.modifierExtension",
"path": "Consent.actor.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"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, and 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" : "*"
},
{
"id": "Consent.actor.role",
"path": "Consent.actor.role",
"short": "How the actor is involved",
"definition": "How the individual is involved in the resources content that is described in the consent.",
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
}
"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"
},
{
"id": "Consent.actor.reference",
"path": "Consent.actor.reference",
"short": "Resource for the actor (or group, by role)",
"definition": "The resource that identifies the actor. To identify a 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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
"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"
},
{
"id": "Consent.action",
"path": "Consent.action",
"short": "Actions controlled by this consent",
"definition": "Actions controlled by this consent.",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
"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"
}],
"example" : [{
"label" : "General",
"valueIdentifier" : {
"system" : "urn:ietf:rfc:3986",
"value" : "Local eCMS 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"
},
{
"id": "Consent.organization",
"path": "Consent.organization",
"short": "Custodian of the consent",
"definition": "The organization that manages the consent, and the framework within which it is executed.",
"alias": [
"custodian"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"id": "Consent.source[x]",
"path": "Consent.source[x]",
"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, or 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": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Identifier"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Contract"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
}
],
"isSummary": true
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Consent.status",
"path" : "Consent.status",
"short" : "draft | proposed | active | rejected | inactive | entered-in-error",
"definition" : "Indicates the current state of this consent.",
"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.",
"requirements" : "The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.status",
"min" : 1,
"max" : "1"
},
{
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"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.0.1"
},
{
"id": "Consent.policy.id",
"path": "Consent.policy.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"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. In order 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.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"id": "Consent.policy.modifierExtension",
"path": "Consent.policy.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"identity" : "v2",
"map" : "HL7 Table 0498 - Consent Status"
},
{
"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"
]
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Consent.scope",
"path" : "Consent.scope",
"short" : "Which of the four areas this resource covers (extensible)",
"definition" : "A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.scope",
"min" : 1,
"max" : "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"
]
"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"
}
},
{
"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" : "*"
},
{
"id": "Consent.policyRule",
"path": "Consent.policyRule",
"short": "Policy that this consents to",
"definition": "A referece to the specific computable policy.",
"comment": "If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in 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": "uri"
}
],
"condition": [
"ppc-1"
],
"isSummary": true
"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"
},
{
"id": "Consent.securityLabel",
"path": "Consent.securityLabel",
"short": "Security Labels that define affected resources",
"definition": "A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.",
"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. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
}
"mapping" : [{
"identity" : "workflow",
"map" : "Event.code"
},
{
"id": "Consent.purpose",
"path": "Consent.purpose",
"short": "Context of activities for which the agreement is made",
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.",
"comment": "This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies).",
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
}
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"id": "Consent.dataPeriod",
"path": "Consent.dataPeriod",
"short": "Timeframe for data controlled by this consent",
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this consent.",
"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
"identity" : "v2",
"map" : "HL7 Table 0497 - Consent Type"
},
{
"id": "Consent.data",
"path": "Consent.data",
"short": "Data controlled by this consent",
"definition": "The resources controlled by this consent, if specific resources are referenced.",
"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() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
}
]
"identity" : "rim",
"map" : "CNTRCT"
}]
},
{
"id" : "Consent.patient",
"path" : "Consent.patient",
"short" : "Who the consent applies to",
"definition" : "The patient/healthcare consumer to whom this consent applies.",
"comment" : "Commonly, the patient 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.patient",
"min" : 0,
"max" : "1"
},
{
"id": "Consent.data.id",
"path": "Consent.data.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient"]
}],
"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.subject"
},
{
"id": "Consent.data.extension",
"path": "Consent.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. In order 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.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"id": "Consent.data.modifierExtension",
"path": "Consent.data.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"identity" : "rim",
"map" : "Role"
},
{
"id": "Consent.data.meaning",
"path": "Consent.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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
}
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Consent.dateTime",
"path" : "Consent.dateTime",
"short" : "When this Consent was created or indexed",
"definition" : "When this Consent was issued / created / indexed.",
"comment" : "This is not the time of the original consent, but the time that this statement was made or derived.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.dateTime",
"min" : 0,
"max" : "1"
},
{
"id": "Consent.data.reference",
"path": "Consent.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
"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]"
},
{
"id": "Consent.except",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Except"
}
],
"path": "Consent.except",
"short": "Additional rule - addition or removal of permissions",
"definition": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"id": "Consent.except.id",
"path": "Consent.except.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "v2",
"map" : "Field 13/ Consent Decision Date"
},
{
"id": "Consent.except.extension",
"path": "Consent.except.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. In order 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.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "rim",
"map" : "FinancialConsent effectiveTime"
}]
},
{
"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.",
"alias" : ["consentor"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.performer",
"min" : 0,
"max" : "*"
},
{
"id": "Consent.except.modifierExtension",
"path": "Consent.except.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"type" : [{
"code" : "Reference",
"targetProfile" : ["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"
},
{
"id": "Consent.except.type",
"path": "Consent.except.type",
"short": "deny | permit",
"definition": "Action to take - permit or deny - when the exception conditions are met.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentExceptType"
}
],
"strength": "required",
"description": "How an exception statement is applied, such as adding additional consent or removing consent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-except-type"
}
}
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"id": "Consent.except.period",
"path": "Consent.except.period",
"short": "Timeframe for this exception",
"definition": "The timeframe in this exception is valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true
"identity" : "v2",
"map" : "Field 24/ ConsenterID"
}]
},
{
"id" : "Consent.organization",
"path" : "Consent.organization",
"short" : "Custodian of the consent",
"definition" : "The organization that manages the consent, and the framework within which it is executed.",
"alias" : ["custodian"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.organization",
"min" : 0,
"max" : "*"
},
{
"id": "Consent.except.actor",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ExceptActor"
}
],
"path": "Consent.except.actor",
"short": "Who|what controlled by this exception (or group, by role)",
"definition": "Who or what is controlled by this Exception. 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",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"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"
},
{
"id": "Consent.except.actor.id",
"path": "Consent.except.actor.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "Consent.source[x]",
"path" : "Consent.source[x]",
"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, or 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" : "1",
"base" : {
"path" : "Consent.source[x]",
"min" : 0,
"max" : "1"
},
{
"id": "Consent.except.actor.extension",
"path": "Consent.except.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. In order 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.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"type" : [{
"code" : "Attachment"
},
{
"id": "Consent.except.actor.modifierExtension",
"path": "Consent.except.actor.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"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" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Field 19 Informational Material Supplied Indicator"
}]
},
{
"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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.policy",
"min" : 0,
"max" : "*"
},
{
"id": "Consent.except.actor.role",
"path": "Consent.except.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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
}
"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
},
{
"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"
},
{
"id": "Consent.except.actor.reference",
"path": "Consent.except.actor.reference",
"short": "Resource for the actor (or group, by role)",
"definition": "The resource that identifies the actor. To identify a 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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"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" : "*"
},
{
"id": "Consent.except.action",
"path": "Consent.except.action",
"short": "Actions controlled by this exception",
"definition": "Actions controlled by this Exception.",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
}
"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"
},
{
"id": "Consent.except.securityLabel",
"path": "Consent.except.securityLabel",
"short": "Security Labels that define affected resources",
"definition": "A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.",
"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. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
}
"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" : "*"
},
{
"id": "Consent.except.purpose",
"path": "Consent.except.purpose",
"short": "Context of activities covered by this exception",
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.",
"comment": "E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
}
"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"
},
{
"id": "Consent.except.class",
"path": "Consent.except.class",
"short": "e.g. Resource Type, Profile, or CDA etc",
"definition": "The class of information covered by this exception. 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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-class"
}
}
"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"
},
{
"id": "Consent.except.code",
"path": "Consent.except.code",
"short": "e.g. LOINC or SNOMED CT code, etc in the content",
"definition": "If this code is found in an instance, then the exception applies.",
"comment": "Typical use of this is a Document code with class = CDA.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-code"
}
}
"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"
},
{
"id": "Consent.except.dataPeriod",
"path": "Consent.except.dataPeriod",
"short": "Timeframe for data controlled by this exception",
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this exception.",
"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
"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"
},
{
"id": "Consent.except.data",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ExceptData"
}
],
"path": "Consent.except.data",
"short": "Data controlled by this exception",
"definition": "The resources controlled by this exception, if specific resources are referenced.",
"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() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
}
]
"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"
}
},
{
"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" : "*"
},
{
"id": "Consent.except.data.id",
"path": "Consent.except.data.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"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",
"valueUrl" : "string"
}],
"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"
},
{
"id": "Consent.except.data.extension",
"path": "Consent.except.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. In order 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.",
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
"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"
},
{
"id": "Consent.except.data.modifierExtension",
"path": "Consent.except.data.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
"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.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 verification was collected.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.verification.verificationDate",
"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" : 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",
"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",
"valueUrl" : "string"
}],
"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"
},
{
"id": "Consent.except.data.meaning",
"path": "Consent.except.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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
}
"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"
},
{
"id": "Consent.except.data.reference",
"path": "Consent.except.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
"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.0.1"
}
]
},
"differential": {
"element": [
{
"id": "Consent",
"path": "Consent",
"short": "A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time",
"definition": "A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.",
"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 general advance care directives.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "ppc-1",
"severity": "error",
"human": "Either a Policy or PolicyRule",
"expression": "policy.exists() or policyRule.exists()",
"xpath": "exists(f:policy) or exists(f:policyRule)"
}
],
"mapping": [
{
"identity": "rim",
"map": "FinancialConsent"
},
{
"identity": "w5",
"map": "infrastructure.information"
}
]
},
{
"id" : "Consent.provision.period",
"path" : "Consent.provision.period",
"short" : "Timeframe for this rule",
"definition" : "The timeframe in this rule is valid.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.provision.period",
"min" : 0,
"max" : "1"
},
{
"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 is 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": "1",
"type": [
{
"code": "Identifier"
}
],
"example": [
{
"label": "General",
"valueIdentifier": {
"system": "urn:ietf:rfc:3986",
"value": "Local eCMS identifier"
}
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
"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.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",
"valueUrl" : "string"
}],
"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"
},
{
"id": "Consent.status",
"path": "Consent.status",
"short": "draft | proposed | active | rejected | inactive | entered-in-error",
"definition": "Indicates the current state of this consent.",
"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.",
"requirements": "The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentState"
}
],
"strength": "required",
"description": "Indicates the state of the consent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-state-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "HL7 Table 0498 - Consent Status"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
"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"
},
{
"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": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentCategory"
}
],
"strength": "example",
"description": "A classification of the type of consents found in a consent statement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-category"
}
"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"
},
"mapping": [
{
"identity": "rim",
"map": "CNTRCT"
},
{
"identity": "w5",
"map": "class"
}
]
{
"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" : "*"
},
{
"id": "Consent.patient",
"path": "Consent.patient",
"short": "Who the consent applies to",
"definition": "The patient/healthcare consumer to whom this consent applies.",
"comment": "Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
"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" : "*"
},
{
"id": "Consent.period",
"path": "Consent.period",
"short": "Period that this consent applies",
"definition": "Relevant time or time-period when this Consent is applicable.",
"comment": "This can be a subset of the period of the original statement.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"meaningWhenMissing": "all date ranges included",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialConsent activityTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
"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" : "*"
},
{
"id": "Consent.dateTime",
"path": "Consent.dateTime",
"short": "When this Consent was created or indexed",
"definition": "When this Consent was issued / created / indexed.",
"comment": "This is not the time of the original consent, but the time that this statement was made or derived.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialConsent effectiveTime"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
"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"
},
{
"id": "Consent.consentingParty",
"path": "Consent.consentingParty",
"short": "Who is agreeing to the policy and exceptions",
"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.",
"alias": [
"consentor"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
"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" : "*"
},
{
"id": "Consent.actor",
"path": "Consent.actor",
"short": "Who|what controlled by this consent (or group, by role)",
"definition": "Who or what is controlled by this consent. 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 consent",
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
"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,
"mapping" : [{
"identity" : "rim",
"map" : "Role"
}]
},
{
"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"
},
{
"id": "Consent.actor.role",
"path": "Consent.actor.role",
"short": "How the actor is involved",
"definition": "How the individual is involved in the resources content that is described in the consent.",
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
}
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"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" : "*"
},
{
"id": "Consent.actor.reference",
"path": "Consent.actor.reference",
"short": "Resource for the actor (or group, by role)",
"definition": "The resource that identifies the actor. To identify a 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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
"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"
},
{
"id": "Consent.action",
"path": "Consent.action",
"short": "Actions controlled by this consent",
"definition": "Actions controlled by this consent.",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
}
"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" : "*"
},
{
"id": "Consent.organization",
"path": "Consent.organization",
"short": "Custodian of the consent",
"definition": "The organization that manages the consent, and the framework within which it is executed.",
"alias": [
"custodian"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
"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"
},
{
"id": "Consent.source[x]",
"path": "Consent.source[x]",
"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, or 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": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Identifier"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Consent"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Contract"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
}
],
"isSummary": true
"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.0.1"
}
},
{
"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 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, 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 general advance care directives.",
"min" : 0,
"max" : "*",
"constraint" : [{
"key" : "ppc-4",
"severity" : "error",
"human" : "IF Scope=adr, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='adr'])))"
},
{
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
"key" : "ppc-5",
"severity" : "error",
"human" : "IF Scope=treatment, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='treatment'])))"
},
{
"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"
]
"key" : "ppc-2",
"severity" : "error",
"human" : "IF Scope=privacy, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='patient-privacy'])))"
},
{
"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"
]
"key" : "ppc-3",
"severity" : "error",
"human" : "IF Scope=research, there must be a patient",
"expression" : "patient.exists() or scope.coding.where(system='something' and code='research').exists().not()",
"xpath" : "exists(f:patient) or not(exists(f:scope/f:coding[f:system/@value='something' and f:code/@value='research'])))"
},
{
"id": "Consent.policyRule",
"path": "Consent.policyRule",
"short": "Policy that this consents to",
"definition": "A referece to the specific computable policy.",
"comment": "If the policy reference is not known, the resource cannot be processed. Where the reference is absent, there is no particular policy other than what is expressed directly in 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": "uri"
}
],
"condition": [
"ppc-1"
],
"isSummary": true
"key" : "ppc-1",
"severity" : "error",
"human" : "Either a Policy or PolicyRule",
"expression" : "policy.exists() or policyRule.exists()",
"xpath" : "exists(f:policy) or exists(f:policyRule)"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Event"
},
{
"id": "Consent.securityLabel",
"path": "Consent.securityLabel",
"short": "Security Labels that define affected resources",
"definition": "A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.",
"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. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
}
"identity" : "v2",
"map" : "CON"
},
{
"id": "Consent.purpose",
"path": "Consent.purpose",
"short": "Context of activities for which the agreement is made",
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.",
"comment": "This element is for discoverability / documentation, and does not modify or qualify the policy (e.g. the policy itself describes the purposes for which it applies).",
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
"identity" : "rim",
"map" : "FinancialConsent"
}]
},
{
"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"
}],
"example" : [{
"label" : "General",
"valueIdentifier" : {
"system" : "urn:ietf:rfc:3986",
"value" : "Local eCMS identifier"
}
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"id": "Consent.dataPeriod",
"path": "Consent.dataPeriod",
"short": "Timeframe for data controlled by this consent",
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this consent.",
"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
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"id": "Consent.data",
"path": "Consent.data",
"short": "Data controlled by this consent",
"definition": "The resources controlled by this consent, if specific resources are referenced.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"meaningWhenMissing": "all data",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
}
]
"identity" : "rim",
"map" : ".id"
}]
},
{
"id" : "Consent.status",
"path" : "Consent.status",
"short" : "draft | proposed | active | rejected | inactive | entered-in-error",
"definition" : "Indicates the current state of this consent.",
"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.",
"requirements" : "The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.",
"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.0.1"
},
{
"id": "Consent.data.meaning",
"path": "Consent.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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
}
"mapping" : [{
"identity" : "workflow",
"map" : "Event.status"
},
{
"id": "Consent.data.reference",
"path": "Consent.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
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"id": "Consent.except",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Except"
}
],
"path": "Consent.except",
"short": "Additional rule - addition or removal of permissions",
"definition": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
"identity" : "v2",
"map" : "HL7 Table 0498 - Consent Status"
},
{
"id": "Consent.except.type",
"path": "Consent.except.type",
"short": "deny | permit",
"definition": "Action to take - permit or deny - when the exception conditions are met.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentExceptType"
}
],
"strength": "required",
"description": "How an exception statement is applied, such as adding additional consent or removing consent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-except-type"
}
}
"identity" : "rim",
"map" : ".statusCode"
}]
},
{
"id" : "Consent.scope",
"path" : "Consent.scope",
"short" : "Which of the four areas this resource covers (extensible)",
"definition" : "A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.",
"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"
}
},
{
"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"
},
{
"id": "Consent.except.period",
"path": "Consent.except.period",
"short": "Timeframe for this exception",
"definition": "The timeframe in this exception is valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"id": "Consent.except.actor",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ExceptActor"
}
],
"path": "Consent.except.actor",
"short": "Who|what controlled by this exception (or group, by role)",
"definition": "Who or what is controlled by this Exception. 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",
"isSummary": true
"identity" : "v2",
"map" : "HL7 Table 0497 - Consent Type"
},
{
"id": "Consent.except.actor.role",
"path": "Consent.except.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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
}
"identity" : "rim",
"map" : "CNTRCT"
}]
},
{
"id" : "Consent.patient",
"path" : "Consent.patient",
"short" : "Who the consent applies to",
"definition" : "The patient/healthcare consumer to whom this consent applies.",
"comment" : "Commonly, the patient 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"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.subject"
},
{
"id": "Consent.except.actor.reference",
"path": "Consent.except.actor.reference",
"short": "Resource for the actor (or group, by role)",
"definition": "The resource that identifies the actor. To identify a 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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
"identity" : "w5",
"map" : "FiveWs.subject[x]"
},
{
"id": "Consent.except.action",
"path": "Consent.except.action",
"short": "Actions controlled by this exception",
"definition": "Actions controlled by this Exception.",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
}
"identity" : "rim",
"map" : "Role"
},
{
"id": "Consent.except.securityLabel",
"path": "Consent.except.securityLabel",
"short": "Security Labels that define affected resources",
"definition": "A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.",
"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. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
}
"identity" : "w5",
"map" : "FiveWs.subject"
}]
},
{
"id" : "Consent.dateTime",
"path" : "Consent.dateTime",
"short" : "When this Consent was created or indexed",
"definition" : "When this Consent was issued / created / indexed.",
"comment" : "This is not the time of the original consent, but the time that this statement was made or derived.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.occurrence[x]"
},
{
"id": "Consent.except.purpose",
"path": "Consent.except.purpose",
"short": "Context of activities covered by this exception",
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.",
"comment": "E.g. if the purpose is 'research', then the operational context must be research, in order for the consent to apply. Not all of the security labels make sense for use in this element (may define a narrower value set?).",
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
}
"identity" : "w5",
"map" : "FiveWs.recorded"
},
{
"id": "Consent.except.class",
"path": "Consent.except.class",
"short": "e.g. Resource Type, Profile, or CDA etc",
"definition": "The class of information covered by this exception. 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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-class"
}
}
"identity" : "v2",
"map" : "Field 13/ Consent Decision Date"
},
{
"id": "Consent.except.code",
"path": "Consent.except.code",
"short": "e.g. LOINC or SNOMED CT code, etc in the content",
"definition": "If this code is found in an instance, then the exception applies.",
"comment": "Typical use of this is a Document code with class = CDA.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-code"
}
}
"identity" : "rim",
"map" : "FinancialConsent effectiveTime"
}]
},
{
"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.",
"alias" : ["consentor"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["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"
},
{
"id": "Consent.except.dataPeriod",
"path": "Consent.except.dataPeriod",
"short": "Timeframe for data controlled by this exception",
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this exception.",
"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
"identity" : "w5",
"map" : "FiveWs.actor"
},
{
"id": "Consent.except.data",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ExceptData"
}
],
"path": "Consent.except.data",
"short": "Data controlled by this exception",
"definition": "The resources controlled by this exception, if specific resources are referenced.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"meaningWhenMissing": "all data",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
}
]
"identity" : "v2",
"map" : "Field 24/ ConsenterID"
}]
},
{
"id" : "Consent.organization",
"path" : "Consent.organization",
"short" : "Custodian of the consent",
"definition" : "The organization that manages the consent, and the framework within which it is executed.",
"alias" : ["custodian"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Event.performer"
},
{
"id": "Consent.except.data.meaning",
"path": "Consent.except.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",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
}
"identity" : "w5",
"map" : "FiveWs.witness"
}]
},
{
"id" : "Consent.source[x]",
"path" : "Consent.source[x]",
"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, or 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" : "1",
"type" : [{
"code" : "Attachment"
},
{
"id": "Consent.except.data.reference",
"path": "Consent.except.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
"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"]
}],
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Field 19 Informational Material Supplied Indicator"
}]
},
{
"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.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"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"
}
]
},
{
"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.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 verification was collected.",
"min" : 0,
"max" : "1",
"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",
"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.0.1"
}
},
{
"id" : "Consent.provision.period",
"path" : "Consent.provision.period",
"short" : "Timeframe for this rule",
"definition" : "The timeframe in this rule is valid.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
},
{
"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,
"mapping" : [{
"identity" : "rim",
"map" : "Role"
}]
},
{
"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.0.1"
}
},
{
"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.
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
4
(Technical
Correction
#1)
(v4.0.1)
generated
on
Thurs,
Oct
24,
Fri,
Nov
1,
2019
11:53+1100.
09:34+1100.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU2
R3
|
|
Propose
a
change