FHIR IG analytics| Package | org.savannahghi.healthyroute |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-hr-consent.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/savannahghi/healthy-route-ig/StructureDefinition-hr-consent.html |
| URL | https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-consent |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-09-04T13:29:51+00:00 |
| Name | HRConsent |
| Title | Healthy Route Consent |
| Description | The record that a participant granted or refused one permission, and the index to the page they signed. |
| Purpose | Establishes the lawful basis for every subsequent resource held about the participant. A screening encounter, a specimen or a retinal image that cannot be traced to an active consent for the permission it relies on is a finding at audit, and this resource is what makes that traceable rather than a matter of correspondence. |
| Type | Consent |
| Kind | resource |
| StructureDefinition | ||
| org.savannahghi.healthyroute#current | hr-research-subject | Healthy Route Study Participation |
| StructureDefinition | ||
| org.savannahghi.healthyroute#current | hr-consent-evidence | Healthy Route Consent Evidence |
| org.savannahghi.healthyroute#current | hr-document-reference | Healthy Route Document |
| org.savannahghi.healthyroute#current | hr-organization | Healthy Route Organization |
| org.savannahghi.healthyroute#current | hr-patient | Healthy Route Patient |
| org.savannahghi.healthyroute#current | hr-practitioner | Healthy Route Practitioner |
| org.savannahghi.healthyroute#current | hr-tenant | Tenant |
| ValueSet | ||
| org.savannahghi.healthyroute#current | hr-consent-permission-vs | Consent Permission Value Set |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition hr-consent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Consent | 0..* | Consent | A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
  Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:tenant | S | 1..1 | Identifier | Owning site tenant URL: https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant |
 status | S | 1..1 | code | draft | active | inactive | not-done | entered-in-error | unknown |
 Slices for category | S | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:coding.system |
| category:permission | S | 1..1 | CodeableConcept | Which permission this resource records Binding: Consent Permission Value Set (required) |
  coding | S | 1..1 | Coding | Code defined by a terminology system |
 system | S | 1..1 | uri | Identity of the terminology system Required Pattern: https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission |
 subject | S | 1..1 | Reference(Healthy Route Patient) | Who the consent applies to |
| date | S | 1..1 | date | Date the participant signed |
| period | S | 0..1 | Period | Period over which the permission applies |
| grantor | S | 1..1 | Reference(Healthy Route Patient | RelatedPerson) | Who is granting rights according to the policy and rules |
| grantee | S | 1..* | Reference(Healthy Route Organization) | Party the permission is granted to |
| controller | S | 0..* | Reference(Healthy Route Organization) | Data controller |
| sourceReference | S | 0..1 | Reference(Healthy Route Consent Evidence) | The photographed signed page |
| regulatoryBasis | S | 0..* | CodeableConcept | Regulatory framework the consent was taken under |
| policyBasis | S | 1..1 | BackboneElement | Computable version of the backing policy |
| url | S | 1..1 | url | Versioned identifier of the approved information sheet |
| policyText | S | 0..* | Reference(Healthy Route Document) | The approved blank information sheet and consent form |
| verification | S | 1..1 | BackboneElement | Consent Verified by patient or family |
| verified | S | 1..1 | boolean | Has been verified |
| verifiedBy | S | 1..1 | Reference(Healthy Route Practitioner) | Person who took consent |
| verificationDate | S | 1..1 | dateTime | When consent verified |
| decision | S | 1..1 | code | permit or deny |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "hr-consent",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-consent",
"version": "0.1.0",
"name": "HRConsent",
"title": "Healthy Route Consent",
"status": "draft",
"experimental": false,
"date": "2026-09-04T13:29:51+00:00",
"publisher": "Savannah Informatics",
"contact": [
{
"name": "Savannah Informatics",
"telecom": [
{
"system": "url",
"value": "https://savannahghi.org"
}
]
},
{
"name": "Savannah Informatics",
"telecom": [
{
"system": "url",
"value": "https://savannahghi.org"
}
]
}
],
"description": "The record that a participant granted or refused one permission, and the index to the page they signed.",
"purpose": "Establishes the lawful basis for every subsequent resource held about the participant. A screening encounter, a specimen or a retinal image that cannot be traced to an active consent for the permission it relies on is a finding at audit, and this resource is what makes that traceable rather than a matter of correspondence.",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Consent",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Consent",
"path": "Consent",
"short": "A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time",
"definition": "A record of a healthcare consumer’s choices or choices made on their behalf by a third party, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.",
"comment": "Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.",
"min": 0,
"max": "*",
"base": {
"path": "Consent",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity, Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "w5",
"map": "infrastructure.information"
},
{
"identity": "v2",
"map": "CON"
}
]
},
{
"id": "Consent.id",
"path": "Consent.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.meta",
"path": "Consent.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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 its narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
},
{
"id": "Consent.language",
"path": "Consent.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "required",
"description": "IETF language tag for a human language",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"additional": [
{
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|5.0.0"
}
]
}
},
{
"id": "Consent.text",
"path": "Consent.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-6"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Consent.contained",
"path": "Consent.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"condition": [
"dom-2",
"dom-4",
"dom-3",
"dom-5"
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Consent.extension",
"path": "Consent.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 1,
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.extension:tenant",
"path": "Consent.extension",
"sliceName": "tenant",
"short": "Owning site tenant",
"definition": "Identifies the site tenant that owns the resource.",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false
},
{
"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 managable, 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](http://hl7.org/fhir/R5/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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mustSupport": false,
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Consent.identifier",
"path": "Consent.identifier",
"short": "Identifier for this record (external references)",
"definition": "Unique identifier for this copy of the Consent Statement.",
"comment": "This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "CON-4 (Consent Form Number – EI)\nNote: An implementation-specific requirement will be needed"
}
]
},
{
"id": "Consent.status",
"path": "Consent.status",
"short": "draft | active | inactive | not-done | entered-in-error | unknown",
"definition": "Indicates the current state of this Consent resource.",
"comment": "draft is used between the point at which the participant signs and the point at which the record has been checked against the paper. A draft consent does not authorise any activity.",
"requirements": "Withdrawal is recorded by setting this to inactive. The resource is not deleted and its content is not altered, so the fact that consent was once held, and the date it ceased, remain available to an auditor.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"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|5.0.0"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "CON-11 (Consent Status – CNE using table HL70498)"
}
]
},
{
"id": "Consent.category",
"path": "Consent.category",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "coding.system"
}
],
"description": "Sliced by coding system to require exactly one permission code while permitting the HL7 consent category codes alongside it.",
"rules": "open"
},
"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": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-category|5.0.0"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "v2",
"map": "CON-2 (Consent Type - CWE using table HL70496)"
}
]
},
{
"id": "Consent.category:permission",
"path": "Consent.category",
"sliceName": "permission",
"short": "Which permission this resource records",
"definition": "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.",
"comment": "One permission per resource. A participant who is asked three questions on one form is represented by three resources sharing a date and a source reference.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.category",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"binding": {
"strength": "required",
"valueSet": "https://fhir.savannahghi.org/ig/healthy-route/ValueSet/hr-consent-permission-vs"
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "v2",
"map": "CON-2 (Consent Type - CWE using table HL70496)"
}
]
},
{
"id": "Consent.category:permission.id",
"path": "Consent.category.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": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Consent.category:permission.extension",
"path": "Consent.category.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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 managable, 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Consent.category:permission.coding",
"path": "Consent.category.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"max": "1",
"base": {
"path": "CodeableConcept.coding",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id": "Consent.category:permission.coding.id",
"path": "Consent.category.coding.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": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Consent.category:permission.coding.extension",
"path": "Consent.category.coding.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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 managable, 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Consent.category:permission.coding.system",
"path": "Consent.category.coding.system",
"short": "Identity of the terminology system",
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"patternUri": "https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
},
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id": "Consent.category:permission.coding.version",
"path": "Consent.category.coding.version",
"short": "Version of the system - if relevant",
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
},
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id": "Consent.category:permission.coding.code",
"path": "Consent.category.coding.code",
"short": "Symbol in syntax defined by the system",
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"cod-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
},
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id": "Consent.category:permission.coding.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Consent.category.coding.display",
"short": "Representation defined by the system",
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"cod-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
},
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id": "Consent.category:permission.coding.userSelected",
"path": "Consent.category.coding.userSelected",
"short": "If this coding was chosen directly by the user",
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.userSelected",
"min": 0,
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
},
{
"identity": "orim",
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}
]
},
{
"id": "Consent.category:permission.text",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Consent.category.text",
"short": "Plain text representation of the concept",
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id": "Consent.subject",
"path": "Consent.subject",
"short": "Who the consent applies to",
"definition": "The patient/healthcare practitioner or group of persons to whom this consent applies.",
"comment": "Constrained to Patient. Consent is never taken from a practitioner or a group in this study, and the base resource permits both.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-patient"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
}
]
},
{
"id": "Consent.date",
"path": "Consent.date",
"short": "Date the participant signed",
"definition": "Date the consent instance was agreed to.",
"comment": "The date on the paper form, which may precede the date the record was created.",
"requirements": "Compared against the date of the earliest study activity. An encounter, specimen or image dated before this is a protocol deviation, and the comparison is only possible if the signature date rather than the data entry date is recorded here.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "v2",
"map": "CON-13 (Consent Decision Date/Time – DTM)"
}
]
},
{
"id": "Consent.period",
"path": "Consent.period",
"short": "Period over which the permission applies",
"definition": "Effective period for this Consent Resource and all provisions unless specified in that provision.",
"comment": "Distinct from the retention period stated in the information sheet. Present where the permission itself is time limited.",
"alias": [
"period"
],
"min": 0,
"max": "1",
"base": {
"path": "Consent.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.grantor",
"path": "Consent.grantor",
"short": "Who is granting rights according to the policy and rules",
"definition": "The entity responsible for granting the rights listed in a Consent Directive.",
"comment": "Ordinarily the participant. RelatedPerson is admitted because both protocols provide for consent given by a legally authorised representative, and an earlier version of this profile constrained the element to Patient while its own comment said the resource must not preclude that. Where a representative consents, subject remains the participant and grantor is the representative, which is the distinction the two elements exist to carry.",
"alias": [
"grantor"
],
"min": 1,
"max": "1",
"base": {
"path": "Consent.grantor",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.grantee",
"path": "Consent.grantee",
"short": "Party the permission is granted to",
"definition": "The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.",
"comment": "In a fully computable consent, both grantee and grantor will be listed as actors within the consent. The Grantee and Grantor elements are for ease of search only.",
"requirements": "The information sheet names the parties who will hold the data. Where a permission extends beyond the site to a party receiving the exported data, both appear here, and a permission naming only the site does not authorise transfer.",
"alias": [
"grantee"
],
"min": 1,
"max": "*",
"base": {
"path": "Consent.grantee",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.manager",
"path": "Consent.manager",
"short": "Consent workflow management",
"definition": "The actor that manages the consent through its lifecycle.",
"alias": [
"manager"
],
"min": 0,
"max": "*",
"base": {
"path": "Consent.manager",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/HealthcareService|5.0.0",
"http://hl7.org/fhir/StructureDefinition/Organization|5.0.0",
"http://hl7.org/fhir/StructureDefinition/Patient|5.0.0",
"http://hl7.org/fhir/StructureDefinition/Practitioner|5.0.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "Consent.controller",
"path": "Consent.controller",
"short": "Data controller",
"definition": "The actor that controls/enforces the access according to the consent.",
"alias": [
"controller"
],
"min": 0,
"max": "*",
"base": {
"path": "Consent.controller",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.sourceAttachment",
"path": "Consent.sourceAttachment",
"short": "Source from which this consent is taken",
"definition": "The source on which this consent statement is based. The source might be a scanned original paper form.",
"comment": "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.sourceAttachment",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Attachment"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "Potential mappings to CON-5,6,7,8,16,19, 20-23"
}
]
},
{
"id": "Consent.sourceReference",
"path": "Consent.sourceReference",
"short": "The photographed signed page",
"definition": "A reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.",
"comment": "Optional, and expected to be absent at most sites. The protocol requires the investigator to retain the signed form and states that no records may be transferred to another location or party without written notification to the sponsor; it requires the medical record to carry a statement that consent was obtained and the date, which this resource satisfies without an image. Present only where a site has chosen to hold a photograph of the page within its own tenant and its ethics committee has approved that, which is a decision beyond the protocol rather than one it mandates.",
"min": 0,
"max": "1",
"base": {
"path": "Consent.sourceReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-consent-evidence"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "Potential mappings to CON-5,6,7,8,16,19, 20-23"
}
]
},
{
"id": "Consent.regulatoryBasis",
"path": "Consent.regulatoryBasis",
"short": "Regulatory framework the consent was taken under",
"definition": "A set of codes that indicate the regulatory basis (if any) that this consent supports.",
"comment": "The national research regulation that governs the site, which differs between participating countries. Country variation is carried on instances rather than by separate profiles.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.regulatoryBasis",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentRegulatoryBasis"
}
],
"strength": "example",
"description": "Regulatory policy examples",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-policy|5.0.0"
},
"mapping": [
{
"identity": "v2",
"map": "CON-3 (Consent Form ID and Version – ST)\nNote: An implementation-specific requirement will be needed"
}
]
},
{
"id": "Consent.policyBasis",
"path": "Consent.policyBasis",
"short": "Computable version of the backing policy",
"definition": "A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.policyBasis",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.policyBasis.id",
"path": "Consent.policyBasis.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"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Consent.policyBasis.extension",
"path": "Consent.policyBasis.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 managable, 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Consent.policyBasis.modifierExtension",
"path": "Consent.policyBasis.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 managable, 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](http://hl7.org/fhir/R5/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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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.policyBasis.reference",
"path": "Consent.policyBasis.reference",
"short": "Reference backing policy resource",
"definition": "A Reference that identifies the policy the organization will enforce for this Consent.",
"comment": "While any resource may be used, Consent, PlanDefinition and Contract would be most frequent",
"min": 0,
"max": "1",
"base": {
"path": "Consent.policyBasis.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource|5.0.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.policyBasis.url",
"path": "Consent.policyBasis.url",
"short": "Versioned identifier of the approved information sheet",
"definition": "A URL that links to a computable version of the policy the organization will enforce for this Consent.",
"comment": "Identifies a version, not a document to display. The document itself is referenced from policyText.",
"requirements": "Ethics committees approve a specific version of the participant information sheet and consent form. Establishing which version a participant was shown is the first question asked when a form is amended mid-study, and it cannot be answered from the signature alone.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.policyBasis.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.policyText",
"path": "Consent.policyText",
"short": "The approved blank information sheet and consent form",
"definition": "A Reference to the human readable policy explaining the basis for the Consent.",
"comment": "The unsigned template as approved, identical for every participant given that version. Not to be confused with sourceReference, which is the individual signed page and is identifying.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.policyText",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-document-reference"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false
},
{
"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": 1,
"max": "1",
"base": {
"path": "Consent.verification",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"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"
}
],
"condition": [
"ele-1"
],
"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 managable, 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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 managable, 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](http://hl7.org/fhir/R5/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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.verification.verificationType",
"path": "Consent.verification.verificationType",
"short": "Business case of verification",
"definition": "Extensible list of verification type starting with verification and re-validation.",
"comment": "This allows the verification element to hold multiple use cases including RelatedPerson verification of the Grantee decision and periodic re-validation of the consent.",
"min": 0,
"max": "1",
"base": {
"path": "Consent.verification.verificationType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentVerificationType"
}
],
"strength": "example",
"description": "Types of Verification/Validation.",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-verification|5.0.0"
}
},
{
"id": "Consent.verification.verifiedBy",
"path": "Consent.verification.verifiedBy",
"short": "Person who took consent",
"definition": "The person who conducted the verification/validation of the Grantor decision.",
"comment": "The individual, not the organisation and not the role they held. The base resource admits all three; an organisation cannot be delegated to take consent, and recording the role rather than the person would leave the identity of the signatory on the paper form unmatched in the record. Where the delegation itself needs to be established, a PractitionerRole referring to the same practitioner carries it.",
"requirements": "Good clinical practice requires that consent be taken by a person authorised to do so on the delegation log, and the protocol requires that person to sign the form. Recording who took it is what allows that authorisation to be checked after the fact.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.verification.verifiedBy",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-practitioner"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.verification.verifiedWith",
"path": "Consent.verification.verifiedWith",
"short": "Person who verified",
"definition": "Who verified the instruction (Patient, Relative or other Authorized Person).",
"min": 0,
"max": "1",
"base": {
"path": "Consent.verification.verifiedWith",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient|5.0.0",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson|5.0.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.verification.verificationDate",
"path": "Consent.verification.verificationDate",
"short": "When consent verified",
"definition": "Date(s) verification was collected.",
"comment": "Allows for history of verification/validation.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.verification.verificationDate",
"min": 0,
"max": "*"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.decision",
"path": "Consent.decision",
"short": "permit or deny",
"definition": "Action to take - permit or deny - as default.",
"comment": "A refusal is recorded as an active consent with a decision of deny, not as an absent resource. The distinction between a participant who declined and a participant who was never asked is material at audit.",
"requirements": "Required, where the base resource makes it optional. A consent record whose decision is absent cannot be acted on, and its absence is indistinguishable from a refusal that was never recorded.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.decision",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isModifier": true,
"isModifierReason": "Sets context for the values in .provision",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentProvisionType"
}
],
"strength": "required",
"description": "Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0"
}
},
{
"id": "Consent.provision",
"path": "Consent.provision",
"short": "Constraints to the base Consent.policyRule/Consent.policy",
"definition": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.provision",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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"
}
],
"condition": [
"ele-1"
],
"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 managable, 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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 managable, 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](http://hl7.org/fhir/R5/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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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.period",
"path": "Consent.provision.period",
"short": "Timeframe for this provision",
"definition": "Timeframe for this provision.",
"comment": "This is the bound effective time of the consent and should be in the base provision in the Consent resource.",
"min": 0,
"max": "1",
"base": {
"path": "Consent.provision.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CON-14&15 (Consent Effective Date Time, Consent End DateTime)"
}
]
},
{
"id": "Consent.provision.actor",
"path": "Consent.provision.actor",
"short": "Who|what controlled by this provision (or group, by role)",
"definition": "Who or what is controlled by this provision. 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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"
}
],
"condition": [
"ele-1"
],
"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 managable, 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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 managable, 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](http://hl7.org/fhir/R5/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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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": 0,
"max": "1",
"base": {
"path": "Consent.provision.actor.role",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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/participation-role-type|5.0.0"
}
},
{
"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": 0,
"max": "1",
"base": {
"path": "Consent.provision.actor.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Device|5.0.0",
"http://hl7.org/fhir/StructureDefinition/Group|5.0.0",
"http://hl7.org/fhir/StructureDefinition/CareTeam|5.0.0",
"http://hl7.org/fhir/StructureDefinition/Organization|5.0.0",
"http://hl7.org/fhir/StructureDefinition/Patient|5.0.0",
"http://hl7.org/fhir/StructureDefinition/Practitioner|5.0.0",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson|5.0.0",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole|5.0.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.provision.action",
"path": "Consent.provision.action",
"short": "Actions controlled by this provision",
"definition": "Actions controlled by this provision.",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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|5.0.0"
}
},
{
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "example",
"description": "Example Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet": "http://hl7.org/fhir/ValueSet/security-label-examples|5.0.0"
}
},
{
"id": "Consent.provision.purpose",
"path": "Consent.provision.purpose",
"short": "Context of activities covered by this provision",
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this provision.",
"comment": "When the purpose of use tag is on the data, access request purpose of use shall not conflict.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.provision.purpose",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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.documentType",
"path": "Consent.provision.documentType",
"short": "e.g. Resource Type, Profile, CDA, etc",
"definition": "The documentType(s) covered by this provision. The type can be 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 documentType element is that the codes refer to document types defined in a standard somewhere.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.provision.documentType",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentClass"
}
],
"strength": "preferred",
"description": "The document type a consent provision covers.",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-content-class|5.0.0"
}
},
{
"id": "Consent.provision.resourceType",
"path": "Consent.provision.resourceType",
"short": "e.g. Resource Type, Profile, etc",
"definition": "The resourceType(s) covered by this provision. The type can be a FHIR resource type or a profile on a type that indicates what information the consent relates to.",
"comment": "Multiple types are or'ed together. The intention of the resourceType 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.resourceType",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentClass"
}
],
"strength": "extensible",
"description": "The resource types a consent provision covers.",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types|5.0.0"
}
},
{
"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 provision applies.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.provision.code",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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|5.0.0"
}
},
{
"id": "Consent.provision.dataPeriod",
"path": "Consent.provision.dataPeriod",
"short": "Timeframe for data controlled by this provision",
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this provision.",
"comment": "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.",
"min": 0,
"max": "1",
"base": {
"path": "Consent.provision.dataPeriod",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.provision.data",
"path": "Consent.provision.data",
"short": "Data controlled by this provision",
"definition": "The resources controlled by this provision if specific resources are referenced.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.provision.data",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"meaningWhenMissing": "all data",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.provision.data.id",
"path": "Consent.provision.data.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"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 managable, 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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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 managable, 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](http://hl7.org/fhir/R5/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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"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|5.0.0"
}
},
{
"id": "Consent.provision.data.reference",
"path": "Consent.provision.data.reference",
"short": "The actual data reference",
"definition": "A reference to a specific resource that defines which resources are covered by this consent.",
"min": 1,
"max": "1",
"base": {
"path": "Consent.provision.data.reference",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource|5.0.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "Consent.provision.expression",
"path": "Consent.provision.expression",
"short": "A computable expression of the consent",
"definition": "A computable (FHIRPath or other) definition of what is controlled by this consent.",
"comment": "Constraining the expression type for a specific implementation via profile is recommended",
"min": 0,
"max": "1",
"base": {
"path": "Consent.provision.expression",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Expression"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
},
{
"id": "Consent.provision.provision",
"path": "Consent.provision.provision",
"short": "Nested Exception Provisions",
"definition": "Provisions which provide exceptions to the base provision or subprovisions.",
"min": 0,
"max": "*",
"base": {
"path": "Consent.provision.provision",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Consent#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())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false
}
]
},
"differential": {
"element": [
{
"id": "Consent",
"path": "Consent"
},
{
"id": "Consent.extension",
"path": "Consent.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Consent.extension:tenant",
"path": "Consent.extension",
"sliceName": "tenant",
"short": "Owning site tenant",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-tenant"
]
}
],
"mustSupport": true
},
{
"id": "Consent.status",
"path": "Consent.status",
"comment": "draft is used between the point at which the participant signs and the point at which the record has been checked against the paper. A draft consent does not authorise any activity.",
"requirements": "Withdrawal is recorded by setting this to inactive. The resource is not deleted and its content is not altered, so the fact that consent was once held, and the date it ceased, remain available to an auditor.",
"mustSupport": true
},
{
"id": "Consent.category",
"path": "Consent.category",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "coding.system"
}
],
"description": "Sliced by coding system to require exactly one permission code while permitting the HL7 consent category codes alongside it.",
"rules": "open"
},
"min": 1,
"mustSupport": true
},
{
"id": "Consent.category:permission",
"path": "Consent.category",
"sliceName": "permission",
"short": "Which permission this resource records",
"comment": "One permission per resource. A participant who is asked three questions on one form is represented by three resources sharing a date and a source reference.",
"min": 1,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "https://fhir.savannahghi.org/ig/healthy-route/ValueSet/hr-consent-permission-vs"
}
},
{
"id": "Consent.category:permission.coding",
"path": "Consent.category.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.category:permission.coding.system",
"path": "Consent.category.coding.system",
"min": 1,
"patternUri": "https://fhir.savannahghi.org/ig/healthy-route/CodeSystem/hr-consent-permission",
"mustSupport": true
},
{
"id": "Consent.subject",
"path": "Consent.subject",
"comment": "Constrained to Patient. Consent is never taken from a practitioner or a group in this study, and the base resource permits both.",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-patient"
]
}
],
"mustSupport": true
},
{
"id": "Consent.date",
"path": "Consent.date",
"short": "Date the participant signed",
"comment": "The date on the paper form, which may precede the date the record was created.",
"requirements": "Compared against the date of the earliest study activity. An encounter, specimen or image dated before this is a protocol deviation, and the comparison is only possible if the signature date rather than the data entry date is recorded here.",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.period",
"path": "Consent.period",
"short": "Period over which the permission applies",
"comment": "Distinct from the retention period stated in the information sheet. Present where the permission itself is time limited.",
"mustSupport": true
},
{
"id": "Consent.grantor",
"path": "Consent.grantor",
"comment": "Ordinarily the participant. RelatedPerson is admitted because both protocols provide for consent given by a legally authorised representative, and an earlier version of this profile constrained the element to Patient while its own comment said the resource must not preclude that. Where a representative consents, subject remains the participant and grantor is the representative, which is the distinction the two elements exist to carry.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"mustSupport": true
},
{
"id": "Consent.grantee",
"path": "Consent.grantee",
"short": "Party the permission is granted to",
"requirements": "The information sheet names the parties who will hold the data. Where a permission extends beyond the site to a party receiving the exported data, both appear here, and a permission naming only the site does not authorise transfer.",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization"
]
}
],
"mustSupport": true
},
{
"id": "Consent.controller",
"path": "Consent.controller",
"short": "Data controller",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-organization"
]
}
],
"mustSupport": true
},
{
"id": "Consent.sourceReference",
"path": "Consent.sourceReference",
"short": "The photographed signed page",
"comment": "Optional, and expected to be absent at most sites. The protocol requires the investigator to retain the signed form and states that no records may be transferred to another location or party without written notification to the sponsor; it requires the medical record to carry a statement that consent was obtained and the date, which this resource satisfies without an image. Present only where a site has chosen to hold a photograph of the page within its own tenant and its ethics committee has approved that, which is a decision beyond the protocol rather than one it mandates.",
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-consent-evidence"
]
}
],
"mustSupport": true
},
{
"id": "Consent.regulatoryBasis",
"path": "Consent.regulatoryBasis",
"short": "Regulatory framework the consent was taken under",
"comment": "The national research regulation that governs the site, which differs between participating countries. Country variation is carried on instances rather than by separate profiles.",
"mustSupport": true
},
{
"id": "Consent.policyBasis",
"path": "Consent.policyBasis",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.policyBasis.url",
"path": "Consent.policyBasis.url",
"short": "Versioned identifier of the approved information sheet",
"comment": "Identifies a version, not a document to display. The document itself is referenced from policyText.",
"requirements": "Ethics committees approve a specific version of the participant information sheet and consent form. Establishing which version a participant was shown is the first question asked when a form is amended mid-study, and it cannot be answered from the signature alone.",
"min": 1,
"mustSupport": true
},
{
"id": "Consent.policyText",
"path": "Consent.policyText",
"short": "The approved blank information sheet and consent form",
"comment": "The unsigned template as approved, identical for every participant given that version. Not to be confused with sourceReference, which is the individual signed page and is identifying.",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-document-reference"
]
}
],
"mustSupport": true
},
{
"id": "Consent.verification",
"path": "Consent.verification",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.verification.verified",
"path": "Consent.verification.verified",
"mustSupport": true
},
{
"id": "Consent.verification.verifiedBy",
"path": "Consent.verification.verifiedBy",
"short": "Person who took consent",
"comment": "The individual, not the organisation and not the role they held. The base resource admits all three; an organisation cannot be delegated to take consent, and recording the role rather than the person would leave the identity of the signatory on the paper form unmatched in the record. Where the delegation itself needs to be established, a PractitionerRole referring to the same practitioner carries it.",
"requirements": "Good clinical practice requires that consent be taken by a person authorised to do so on the delegation log, and the protocol requires that person to sign the form. Recording who took it is what allows that authorisation to be checked after the fact.",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.savannahghi.org/ig/healthy-route/StructureDefinition/hr-practitioner"
]
}
],
"mustSupport": true
},
{
"id": "Consent.verification.verificationDate",
"path": "Consent.verification.verificationDate",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Consent.decision",
"path": "Consent.decision",
"short": "permit or deny",
"comment": "A refusal is recorded as an active consent with a decision of deny, not as an absent resource. The distinction between a participant who declined and a participant who was never asked is material at audit.",
"requirements": "Required, where the base resource makes it optional. A consent record whose decision is absent cannot be acted on, and its absence is indistinguishable from a refusal that was never recorded.",
"min": 1,
"mustSupport": true
}
]
}
}