{
"description": null,
"_filename": "StructureDefinition-PatientConsent.json",
"package_name": "hl7.fhir.us.bser",
"date": "2019-03-27T07:29:43+11:00",
"derivation": "constraint",
"publisher": "Hi3 Solutions",
"fhirVersion": "3.0.1",
"name": "BSeR Patient Consent",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Consent",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
}, {
"key": "ppc-1",
"human": "Either a Policy or PolicyRule",
"xpath": "exists(f:policy) or exists(f:policyRule)",
"source": "Consent",
"severity": "error",
"expression": "policy.exists() or policyRule.exists()"
} ],
"path": "Consent",
"min": 0,
"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.",
"short": "A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "FinancialConsent",
"identity": "rim"
}, {
"map": "infrastructure.information",
"identity": "w5"
} ],
"max": "*",
"id": "Consent",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Consent"
}
}, {
"path": "Consent.id",
"min": 0,
"definition": "MAY contain zero or one [0..1] id (CONF:4383-774).",
"short": "id",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Consent.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Consent.meta",
"min": 0,
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-773).",
"short": "meta",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Consent.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Consent.meta.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.meta.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.meta.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Consent.meta.versionId",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"path": "Consent.meta.lastUpdated",
"min": 0,
"definition": "When the resource last changed - e.g. when the version changed.",
"short": "When the resource version last changed",
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "Consent.meta.lastUpdated",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"path": "Consent.meta.profile",
"min": 1,
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/PatientConsent\" (CONF:4383-775).",
"short": "profile",
"type": [ {
"code": "uri"
} ],
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientConsent",
"max": "1",
"id": "Consent.meta.profile",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"path": "Consent.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "Consent.meta.security",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"path": "Consent.meta.tag",
"min": 0,
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags"
}
},
"max": "*",
"id": "Consent.meta.tag",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"path": "Consent.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.implicitRules",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Consent.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"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
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Consent.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Consent.text",
"min": 0,
"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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Consent.text",
"condition": [ "dom-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Consent.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Consent.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Consent.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Consent.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Consent.identifier",
"min": 0,
"definition": "Unique identifier for this copy of the Consent Statement.",
"short": "Identifier for this record (external references)",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Consent.identifier",
"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.",
"example": [ {
"label": "General",
"valueIdentifier": {
"value": "Local eCMS identifier",
"system": "urn:ietf:rfc:3986"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Consent.identifier"
},
"isSummary": true
}, {
"path": "Consent.status",
"requirements": "The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] status, which SHALL be selected from ValueSet Event-status http://hl7.org/fhir/ValueSet/event-status DYNAMIC (CONF:4383-119).",
"isModifier": true,
"short": "status",
"mapping": [ {
"map": "HL7 Table 0498 - Consent Status",
"identity": "v2"
}, {
"map": ".statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-status"
}
},
"max": "1",
"id": "Consent.status",
"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.",
"base": {
"max": "1",
"min": 1,
"path": "Consent.status"
},
"isSummary": true
}, {
"path": "Consent.category",
"min": 1,
"definition": "SHALL contain exactly one [1..1] category, which SHALL be selected from ValueSet Consent-category http://hl7.org/fhir/ValueSet/consent-category DYNAMIC (CONF:4383-124).",
"short": "category",
"mapping": [ {
"map": "CNTRCT",
"identity": "rim"
}, {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-category"
}
},
"max": "1",
"id": "Consent.category",
"base": {
"max": "*",
"min": 0,
"path": "Consent.category"
},
"isSummary": true
}, {
"path": "Consent.patient",
"min": 1,
"definition": "SHALL contain exactly one [1..1] =\"BSeR Patient\"BSeR Patient (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole) (CONF:4383-120).",
"short": "patient",
"mapping": [ {
"map": "Role",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole"
} ],
"patternString": "BSeR Patient",
"max": "1",
"id": "Consent.patient",
"comment": "Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.",
"base": {
"max": "1",
"min": 1,
"path": "Consent.patient"
},
"isSummary": true
}, {
"path": "Consent.period",
"min": 0,
"definition": "Relevant time or time-period when this Consent is applicable.",
"short": "Period that this consent applies",
"mapping": [ {
"map": "FinancialConsent activityTime",
"identity": "rim"
}, {
"map": "when.done",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"meaningWhenMissing": "all date ranges included",
"max": "1",
"id": "Consent.period",
"comment": "This can be a subset of the period of the original statement.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.period"
},
"isSummary": true
}, {
"path": "Consent.dateTime",
"min": 1,
"definition": "SHALL contain exactly one [1..1] dateTime (CONF:4383-125).",
"short": "dateTime",
"mapping": [ {
"map": "FinancialConsent effectiveTime",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Consent.dateTime",
"comment": "This is not the time of the original consent, but the time that this statement was made or derived.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.dateTime"
},
"isSummary": true
}, {
"path": "Consent.consentingParty",
"min": 1,
"definition": "SHALL contain at least one [1..*] =\"BSeR Related Person\"BSeR Related Person (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PatientRelatedPerson) (CONF:4383-121).",
"short": "consentingParty",
"mapping": [ {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRelatedPerson"
} ],
"patternString": "BSeR Related Person",
"alias": [ "consentor" ],
"max": "*",
"id": "Consent.consentingParty",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.consentingParty"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.actor",
"min": 1,
"definition": "SHALL contain at least one [1..*] actor (CONF:4383-122).",
"short": "actor",
"mapping": [ {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "There is no specific actor associated with the consent",
"max": "*",
"id": "Consent.actor",
"base": {
"max": "*",
"min": 0,
"path": "Consent.actor"
},
"isSummary": true
}, {
"path": "Consent.actor.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.actor.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.actor.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.actor.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.actor.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.actor.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.actor.role",
"min": 1,
"definition": "Such actors SHALL contain exactly one [1..1] role, which SHALL be selected from ValueSet Security-role-type http://hl7.org/fhir/ValueSet/security-role-type DYNAMIC (CONF:4383-126).",
"short": "role",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
"max": "1",
"id": "Consent.actor.role",
"base": {
"max": "1",
"min": 1,
"path": "Consent.actor.role"
}
}, {
"path": "Consent.actor.reference",
"min": 1,
"definition": "Such actors SHALL contain exactly one [1..1] =\"BSeR Practitioner\"BSeR Practitioner (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson) (CONF:4383-123).",
"short": "reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson"
} ],
"patternString": "BSeR Practitioner",
"max": "1",
"id": "Consent.actor.reference",
"base": {
"max": "1",
"min": 1,
"path": "Consent.actor.reference"
}
}, {
"path": "Consent.action",
"min": 0,
"definition": "Actions controlled by this consent.",
"short": "Actions controlled by this consent",
"type": [ {
"code": "CodeableConcept"
} ],
"meaningWhenMissing": "all actions",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentAction"
} ],
"description": "Detailed codes for the consent action.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
},
"max": "*",
"id": "Consent.action",
"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'.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.action"
},
"isSummary": true
}, {
"path": "Consent.organization",
"min": 0,
"definition": "The organization that manages the consent, and the framework within which it is executed.",
"short": "Custodian of the consent",
"mapping": [ {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"alias": [ "custodian" ],
"max": "*",
"id": "Consent.organization",
"base": {
"max": "*",
"min": 0,
"path": "Consent.organization"
},
"isSummary": true
}, {
"path": "Consent.source[x]",
"min": 0,
"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.",
"short": "Source from which this consent is taken",
"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"
} ],
"max": "1",
"id": "Consent.source[x]",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.source[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.policy",
"min": 0,
"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.",
"short": "Policies covered by this consent",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Consent.policy",
"base": {
"max": "*",
"min": 0,
"path": "Consent.policy"
}
}, {
"path": "Consent.policy.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.policy.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.policy.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.policy.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.policy.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.policy.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.policy.authority",
"min": 0,
"definition": "Entity or Organization having regulatory jurisdiction or accountability for  enforcing policies pertaining to Consent Directives.",
"short": "Enforcement source for policy",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.policy.authority",
"condition": [ "ppc-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Consent.policy.authority"
}
}, {
"path": "Consent.policy.uri",
"min": 0,
"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.",
"short": "Specific policy covered by this consent",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.policy.uri",
"condition": [ "ppc-1" ],
"comment": "This element is for discoverability / documentation, and does not modify or qualify the policy rules.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.policy.uri"
}
}, {
"path": "Consent.policyRule",
"requirements": "Might be a unique identifier of a policy set in XACML, or other rules engine.",
"min": 0,
"definition": "A referece to the specific computable policy.",
"short": "Policy that this consents to",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.policyRule",
"condition": [ "ppc-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.policyRule"
},
"isSummary": true
}, {
"path": "Consent.securityLabel",
"min": 0,
"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.",
"short": "Security Labels that define affected resources",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "Consent.securityLabel",
"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?).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.securityLabel"
},
"isSummary": true
}, {
"path": "Consent.purpose",
"min": 0,
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.",
"short": "Context of activities for which the agreement is made",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PurposeOfUse"
} ],
"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"
}
},
"max": "*",
"id": "Consent.purpose",
"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).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.purpose"
},
"isSummary": true
}, {
"path": "Consent.dataPeriod",
"min": 0,
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this consent.",
"short": "Timeframe for data controlled by this consent",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Consent.dataPeriod",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.dataPeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.data",
"min": 0,
"definition": "The resources controlled by this consent, if specific resources are referenced.",
"short": "Data controlled by this consent",
"mapping": [ {
"map": "Role",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "all data",
"max": "*",
"id": "Consent.data",
"base": {
"max": "*",
"min": 0,
"path": "Consent.data"
},
"isSummary": true
}, {
"path": "Consent.data.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.data.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.data.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.data.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.data.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.data.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.data.meaning",
"min": 1,
"definition": "How the resource reference is interpreted when testing consent restrictions.",
"short": "instance | related | dependents | authoredby",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentDataMeaning"
} ],
"description": "How a resource reference is interpreted when testing consent restrictions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
},
"max": "1",
"id": "Consent.data.meaning",
"base": {
"max": "1",
"min": 1,
"path": "Consent.data.meaning"
},
"isSummary": true
}, {
"path": "Consent.data.reference",
"min": 1,
"definition": "A reference to a specific resource that defines which resources are covered by this consent.",
"short": "The actual data reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "Consent.data.reference",
"base": {
"max": "1",
"min": 1,
"path": "Consent.data.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.except",
"min": 0,
"definition": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"short": "Additional rule - addition or removal of permissions",
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Except"
} ],
"max": "*",
"id": "Consent.except",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except"
},
"isSummary": true
}, {
"path": "Consent.except.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.except.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.except.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.except.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.except.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.except.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.except.type",
"min": 1,
"definition": "Action to take - permit or deny - when the exception conditions are met.",
"short": "deny | permit",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentExceptType"
} ],
"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"
}
},
"max": "1",
"id": "Consent.except.type",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.type"
},
"isSummary": true
}, {
"path": "Consent.except.period",
"min": 0,
"definition": "The timeframe in this exception is valid.",
"short": "Timeframe for this exception",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Consent.except.period",
"base": {
"max": "1",
"min": 0,
"path": "Consent.except.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.except.actor",
"min": 0,
"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').",
"short": "Who|what controlled by this exception (or group, by role)",
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "There is no specific actor associated with the exception",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ExceptActor"
} ],
"max": "*",
"id": "Consent.except.actor",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.actor"
},
"isSummary": true
}, {
"path": "Consent.except.actor.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.except.actor.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.except.actor.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.except.actor.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.except.actor.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.except.actor.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.except.actor.role",
"min": 1,
"definition": "How the individual is involved in the resources content that is described in the exception.",
"short": "How the actor is involved",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentActorRole"
} ],
"description": "How an actor is involved in the consent considerations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
"max": "1",
"id": "Consent.except.actor.role",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.actor.role"
}
}, {
"id": "Consent.except.actor.reference",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.actor.reference"
},
"path": "Consent.except.actor.reference",
"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"
} ],
"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')."
}, {
"path": "Consent.except.action",
"min": 0,
"definition": "Actions controlled by this Exception.",
"short": "Actions controlled by this exception",
"type": [ {
"code": "CodeableConcept"
} ],
"meaningWhenMissing": "all actions",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentAction"
} ],
"description": "Detailed codes for the consent action.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-action"
}
},
"max": "*",
"id": "Consent.except.action",
"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'.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.action"
},
"isSummary": true
}, {
"path": "Consent.except.securityLabel",
"min": 0,
"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.",
"short": "Security Labels that define affected resources",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "Consent.except.securityLabel",
"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?).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.securityLabel"
},
"isSummary": true
}, {
"path": "Consent.except.purpose",
"min": 0,
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.",
"short": "Context of activities covered by this exception",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PurposeOfUse"
} ],
"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"
}
},
"max": "*",
"id": "Consent.except.purpose",
"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?).",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.purpose"
},
"isSummary": true
}, {
"path": "Consent.except.class",
"min": 0,
"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.",
"short": "e.g. Resource Type, Profile, or CDA etc",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentClass"
} ],
"description": "The class (type) of information a consent rule covers",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-class"
}
},
"max": "*",
"id": "Consent.except.class",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.class"
},
"isSummary": true
}, {
"path": "Consent.except.code",
"min": 0,
"definition": "If this code is found in an instance, then the exception applies.",
"short": "e.g. LOINC or SNOMED CT code, etc in the content",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentCode"
} ],
"description": "If this code is found in an instance, then the exception applies",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-content-code"
}
},
"max": "*",
"id": "Consent.except.code",
"comment": "Typical use of this is a Document code with class = CDA.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.code"
},
"isSummary": true
}, {
"path": "Consent.except.dataPeriod",
"min": 0,
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this exception.",
"short": "Timeframe for data controlled by this exception",
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Consent.except.dataPeriod",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.except.dataPeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Consent.except.data",
"min": 0,
"definition": "The resources controlled by this exception, if specific resources are referenced.",
"short": "Data controlled by this exception",
"mapping": [ {
"map": "Role",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"meaningWhenMissing": "all data",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ExceptData"
} ],
"max": "*",
"id": "Consent.except.data",
"base": {
"max": "*",
"min": 0,
"path": "Consent.except.data"
},
"isSummary": true
}, {
"path": "Consent.except.data.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.except.data.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Consent.except.data.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.except.data.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Consent.except.data.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.except.data.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Consent.except.data.meaning",
"min": 1,
"definition": "How the resource reference is interpreted when testing consent restrictions.",
"short": "instance | related | dependents | authoredby",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentDataMeaning"
} ],
"description": "How a resource reference is interpreted when testing consent restrictions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-data-meaning"
}
},
"max": "1",
"id": "Consent.except.data.meaning",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.data.meaning"
},
"isSummary": true
}, {
"path": "Consent.except.data.reference",
"min": 1,
"definition": "A reference to a specific resource that defines which resources are covered by this consent.",
"short": "The actual data reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "Consent.except.data.reference",
"base": {
"max": "1",
"min": 1,
"path": "Consent.except.data.reference"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "1ce43aa1-83f9-41ff-87c8-81871766d900",
"kind": "resource",
"url": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientConsent",
"context": [ "Consent" ],
"version": "0.2.0",
"differential": {
"element": [ {
"id": "Consent",
"path": "Consent"
}, {
"id": "Consent.id",
"max": "1",
"min": 0,
"path": "Consent.id",
"short": "id",
"definition": "MAY contain zero or one [0..1] id (CONF:4383-774)."
}, {
"id": "Consent.meta",
"max": "1",
"min": 0,
"path": "Consent.meta",
"short": "meta",
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-773)."
}, {
"id": "Consent.meta.profile",
"max": "1",
"min": 1,
"path": "Consent.meta.profile",
"short": "profile",
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/PatientConsent\" (CONF:4383-775).",
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientConsent"
}, {
"id": "Consent.status",
"max": "1",
"min": 1,
"path": "Consent.status",
"type": [ {
"code": "code"
} ],
"short": "status",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/event-status"
}
},
"definition": "SHALL contain exactly one [1..1] status, which SHALL be selected from ValueSet Event-status http://hl7.org/fhir/ValueSet/event-status DYNAMIC (CONF:4383-119)."
}, {
"id": "Consent.category",
"max": "1",
"min": 1,
"path": "Consent.category",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "category",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/consent-category"
}
},
"definition": "SHALL contain exactly one [1..1] category, which SHALL be selected from ValueSet Consent-category http://hl7.org/fhir/ValueSet/consent-category DYNAMIC (CONF:4383-124)."
}, {
"id": "Consent.patient",
"max": "1",
"min": 1,
"path": "Consent.patient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole"
} ],
"short": "patient",
"definition": "SHALL contain exactly one [1..1] =\"BSeR Patient\"BSeR Patient (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole) (CONF:4383-120).",
"patternString": "BSeR Patient"
}, {
"id": "Consent.dateTime",
"max": "1",
"min": 1,
"path": "Consent.dateTime",
"short": "dateTime",
"definition": "SHALL contain exactly one [1..1] dateTime (CONF:4383-125)."
}, {
"id": "Consent.consentingParty",
"max": "*",
"min": 1,
"path": "Consent.consentingParty",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRelatedPerson"
} ],
"short": "consentingParty",
"definition": "SHALL contain at least one [1..*] =\"BSeR Related Person\"BSeR Related Person (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PatientRelatedPerson) (CONF:4383-121).",
"patternString": "BSeR Related Person"
}, {
"id": "Consent.actor",
"max": "*",
"min": 1,
"path": "Consent.actor",
"short": "actor",
"definition": "SHALL contain at least one [1..*] actor (CONF:4383-122)."
}, {
"id": "Consent.actor.role",
"max": "1",
"min": 1,
"path": "Consent.actor.role",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "role",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
"definition": "Such actors SHALL contain exactly one [1..1] role, which SHALL be selected from ValueSet Security-role-type http://hl7.org/fhir/ValueSet/security-role-type DYNAMIC (CONF:4383-126)."
}, {
"id": "Consent.actor.reference",
"max": "1",
"min": 1,
"path": "Consent.actor.reference",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson"
} ],
"short": "reference",
"definition": "Such actors SHALL contain exactly one [1..1] =\"BSeR Practitioner\"BSeR Practitioner (identifier: http://hl7.org/fhir/us/bser/StructureDefinition/PractitionerPerson) (CONF:4383-123).",
"patternString": "BSeR Practitioner"
} ]
},
"contact": [ {
"name": "AbdulMalik Shakir",
"telecom": [ {
"use": "work",
"value": "6266444491",
"system": "phone"
}, {
"use": "work",
"value": "abdulmalik.shakir@hi3solutions.com",
"system": "email"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent"
}