{
"description": null,
"_filename": "Consent.StructureDefinition.json",
"package_name": "digi.derm",
"date": "2024-04-09T12:28:18.8828014+00:00",
"derivation": "constraint",
"publisher": null,
"fhirVersion": "5.0.0",
"name": "Consent",
"abstract": false,
"type": "Consent",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"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()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"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."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
} ],
"path": "Consent",
"min": 0,
"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.",
"isModifier": false,
"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",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Entity, Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "infrastructure.information",
"identity": "w5"
}, {
"map": "CON",
"identity": "v2"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "*",
"id": "Consent",
"comment": "Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment and consent for research participation and data sharing.",
"base": {
"max": "*",
"min": 0,
"path": "Consent"
}
}, {
"path": "Consent.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "Consent.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "Consent.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "Consent.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "0",
"id": "Consent.text",
"condition": [ "dom-6" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Consent.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, 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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Consent.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "Consent.identifier",
"min": 0,
"definition": "Unique identifier for this copy of the Consent Statement.",
"isModifier": false,
"short": "Identifier for this record (external references)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "CON-4 (Consent Form Number – EI)\nNote: An implementation-specific requirement will be needed",
"identity": "v2"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.identifier",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.status",
"fixedCode": "active",
"min": 1,
"definition": "Indicates the current state of this Consent resource.",
"isModifier": true,
"short": "draft | active | inactive | not-done | entered-in-error | unknown",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "CON-11 (Consent Status – CNE using table HL70498)",
"identity": "v2"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentState"
} ],
"description": "Indicates the state of the consent."
},
"max": "1",
"id": "Consent.status",
"comment": "This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "Consent.status"
},
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category",
"min": 1,
"definition": "A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.",
"isModifier": false,
"short": "Classification of the consent statement - for indexing/retrieval",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "CON-2 (Consent Type - CWE using table HL70496)",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentCategory"
} ],
"description": "A classification of the type of consents found in a consent statement."
},
"max": "1",
"id": "Consent.category",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.category"
},
"isSummary": true
}, {
"path": "Consent.category.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.category.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.category.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.category.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "Consent.category.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "code",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "*",
"id": "Consent.category.coding",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "Consent.category.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "342151000000109",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.category.coding:342151000000109",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Consent.category.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.category.coding:342151000000109.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.category.coding.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.category.coding:342151000000109.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.category.coding:342151000000109.system",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "Consent.category.coding:342151000000109.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.code",
"fixedCode": "342151000000109",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "Consent.category.coding:342151000000109.code",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Consent.category.coding:342151000000109.display",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Consent.category.coding:342151000000109.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "Consent.category.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "704498007",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.category.coding:704498007",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Consent.category.coding.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.category.coding:704498007.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.category.coding.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.category.coding:704498007.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Consent.category.coding:704498007.system",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "Consent.category.coding:704498007.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.code",
"fixedCode": "704498007",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "Consent.category.coding:704498007.code",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Consent.category.coding:704498007.display",
"condition": [ "cod-1" ],
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "0",
"id": "Consent.category.coding:704498007.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.category.text",
"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,
"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.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "Consent.category.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.subject",
"min": 1,
"definition": "The patient/healthcare practitioner or group of persons to whom this consent applies.",
"isModifier": false,
"short": "Who the consent applies to",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.subject",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.subject"
},
"isSummary": true
}, {
"path": "Consent.subject.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.subject.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.subject.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.subject.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.subject.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/Patient",
"id": "Consent.subject.reference",
"condition": [ "ref-2", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.subject.type",
"min": 1,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"fixedUri": "Patient",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "Consent.subject.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "Consent.subject.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.subject.identifier",
"condition": [ "ref-2" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.subject.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "Consent.subject.display",
"condition": [ "ref-2" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.date",
"min": 1,
"definition": "Date the consent instance was agreed to.",
"isModifier": false,
"short": "Fully executed date of the consent",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": "CON-13 (Consent Decision Date/Time – DTM)",
"identity": "v2"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": false,
"max": "1",
"id": "Consent.date",
"base": {
"max": "1",
"min": 0,
"path": "Consent.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower or equal value than end",
"source": "http://hl7.org/fhir/StructureDefinition/Period",
"severity": "error",
"expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())"
} ],
"path": "Consent.period",
"min": 0,
"definition": "Effective period for this Consent Resource and all provisions unless specified in that provision.",
"isModifier": false,
"short": "Effective period for this Consent",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "period" ],
"max": "0",
"id": "Consent.period",
"comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"base": {
"max": "1",
"min": 0,
"path": "Consent.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.grantor",
"min": 1,
"definition": "The entity responsible for granting the rights listed in a Consent Directive.",
"isModifier": false,
"short": "Who is granting rights according to the policy and rules",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "grantor" ],
"max": "1",
"id": "Consent.grantor",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.grantor"
},
"isSummary": true
}, {
"path": "Consent.grantor.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.grantor.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.grantor.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.grantor.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.grantor.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/Patient",
"id": "Consent.grantor.reference",
"condition": [ "ref-2", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.grantor.type",
"min": 1,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"fixedUri": "Patient",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "Consent.grantor.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "Consent.grantor.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.grantor.identifier",
"condition": [ "ref-2" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.grantor.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "Consent.grantor.display",
"condition": [ "ref-2" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.grantee",
"min": 1,
"definition": "The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.",
"isModifier": false,
"short": "Who is agreeing to the policy and rules",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "grantee" ],
"max": "1",
"id": "Consent.grantee",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.grantee"
},
"isSummary": true
}, {
"path": "Consent.grantee.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.grantee.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.grantee.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.grantee.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.grantee.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/Patient",
"id": "Consent.grantee.reference",
"condition": [ "ref-2", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.grantee.type",
"min": 1,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"fixedUri": "Patient",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "Consent.grantee.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "Consent.grantee.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.grantee.identifier",
"condition": [ "ref-2" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.grantee.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "Consent.grantee.display",
"condition": [ "ref-2" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.manager",
"min": 0,
"definition": "The actor that manages the consent through its lifecycle.",
"isModifier": false,
"short": "Consent workflow management",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "manager" ],
"max": "0",
"id": "Consent.manager",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.manager"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.controller",
"min": 0,
"definition": "The actor that controls/enforces the access according to the consent.",
"isModifier": false,
"short": "Consent Enforcer",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "controller" ],
"max": "0",
"id": "Consent.controller",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.controller"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "att-1",
"human": "If the Attachment has data, it SHALL have a contentType",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment",
"severity": "error",
"expression": "data.empty() or contentType.exists()"
} ],
"path": "Consent.sourceAttachment",
"min": 0,
"definition": "The source on which this consent statement is based. The source might be a scanned original paper form.",
"isModifier": false,
"short": "Source from which this consent is taken",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "ED/RP",
"identity": "v2"
}, {
"map": "ED",
"identity": "rim"
}, {
"map": "Potential mappings to CON-5,6,7,8,16,19, 20-23",
"identity": "v2"
} ],
"type": [ {
"code": "Attachment"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.sourceAttachment",
"comment": "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.sourceAttachment"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.sourceReference",
"min": 1,
"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.",
"isModifier": false,
"short": "Source from which this consent is taken",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Potential mappings to CON-5,6,7,8,16,19, 20-23",
"identity": "v2"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Consent", "http://hl7.org/fhir/StructureDefinition/DocumentReference", "http://hl7.org/fhir/StructureDefinition/Contract", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.sourceReference",
"comment": "The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.sourceReference"
},
"isSummary": false
}, {
"path": "Consent.sourceReference.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.sourceReference.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.sourceReference.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.sourceReference.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.sourceReference.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/QuestionnaireResponse",
"id": "Consent.sourceReference.reference",
"condition": [ "ref-2", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.sourceReference.type",
"min": 1,
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"short": "Type the reference refers to (e.g. \"Patient\") - must be a resource in resources",
"fixedUri": "QuestionnaireResponse",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Aa resource (or, for logical models, the URI of the logical model)."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Aa resource (or, for logical models, the URI of the logical model)."
},
"max": "1",
"id": "Consent.sourceReference.type",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ident-1",
"human": "Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason",
"source": "http://hl7.org/fhir/StructureDefinition/Identifier",
"severity": "warning",
"expression": "value.exists()"
} ],
"path": "Consent.sourceReference.identifier",
"min": 0,
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.sourceReference.identifier",
"condition": [ "ref-2" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).\n\nThis element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.sourceReference.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "0",
"id": "Consent.sourceReference.display",
"condition": [ "ref-2" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.regulatoryBasis",
"min": 0,
"definition": "A set of codes that indicate the regulatory basis (if any) that this consent supports.",
"isModifier": false,
"short": "Regulations establishing base Consent",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "CON-3 (Consent Form ID and Version – ST)\nNote: An implementation-specific requirement will be needed",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-policy",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentRegulatoryBasis"
} ],
"description": "Regulatory policy examples"
},
"max": "0",
"id": "Consent.regulatoryBasis",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.regulatoryBasis"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.policyBasis",
"min": 0,
"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.",
"isModifier": false,
"short": "Computable version of the backing policy",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.policyBasis",
"base": {
"max": "1",
"min": 0,
"path": "Consent.policyBasis"
},
"isSummary": false
}, {
"path": "Consent.policyBasis.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.policyBasis.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.policyBasis.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.policyBasis.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.policyBasis.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.policyBasis.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.policyBasis.reference",
"min": 0,
"definition": "A Reference that identifies the policy the organization will enforce for this Consent.",
"isModifier": false,
"short": "Reference backing policy resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.policyBasis.reference",
"comment": "While any resource may be used, Consent, PlanDefinition and Contract would be most frequent",
"base": {
"max": "1",
"min": 0,
"path": "Consent.policyBasis.reference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.policyBasis.url",
"min": 0,
"definition": "A URL that links to a computable version of the policy the organization will enforce for this Consent.",
"isModifier": false,
"short": "URL to a computable backing policy",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "Consent.policyBasis.url",
"comment": "see http://en.wikipedia.org/wiki/Uniform_resource_identifier",
"base": {
"max": "1",
"min": 0,
"path": "Consent.policyBasis.url"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.policyText",
"min": 0,
"definition": "A Reference to the human readable policy explaining the basis for the Consent.",
"isModifier": false,
"short": "Human Readable Policy",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.policyText",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.policyText"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.verification",
"min": 0,
"definition": "Whether a treatment instruction (e.g. artificial respiration: yes or no) was verified with the patient, his/her family or another authorized person.",
"isModifier": false,
"short": "Consent Verified by patient or family",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "0",
"id": "Consent.verification",
"base": {
"max": "*",
"min": 0,
"path": "Consent.verification"
},
"isSummary": true
}, {
"path": "Consent.verification.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.verification.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.verification.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.verification.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.verification.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.verification.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.verification.verified",
"min": 1,
"definition": "Has the instruction been verified.",
"isModifier": false,
"short": "Has been verified",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "Consent.verification.verified",
"base": {
"max": "1",
"min": 1,
"path": "Consent.verification.verified"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.verification.verificationType",
"min": 0,
"definition": "Extensible list of verification type starting with verification and re-validation.",
"isModifier": false,
"short": "Business case of verification",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-verification",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentVerificationType"
} ],
"description": "Types of Verification/Validation."
},
"max": "1",
"id": "Consent.verification.verificationType",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.verification.verificationType"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.verification.verifiedBy",
"min": 0,
"definition": "The person who conducted the verification/validation of the Grantor decision.",
"isModifier": false,
"short": "Person conducting verification",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.verification.verifiedBy",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.verification.verifiedBy"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.verification.verifiedWith",
"min": 0,
"definition": "Who verified the instruction (Patient, Relative or other Authorized Person).",
"isModifier": false,
"short": "Person who verified",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.verification.verifiedWith",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.verification.verifiedWith"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.verification.verificationDate",
"min": 0,
"definition": "Date(s) verification was collected.",
"isModifier": false,
"short": "When consent verified",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "*",
"id": "Consent.verification.verificationDate",
"comment": "Allows for history of verification/validation.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.verification.verificationDate"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.decision",
"fixedCode": "permit",
"min": 1,
"definition": "Action to take - permit or deny - as default.",
"isModifier": true,
"short": "deny | permit",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentProvisionType"
} ],
"description": "Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level."
},
"max": "1",
"id": "Consent.decision",
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 0,
"path": "Consent.decision"
},
"isModifierReason": "Sets context for the values in .provision",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.provision",
"min": 0,
"definition": "An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.",
"isModifier": false,
"short": "Constraints to the base Consent.policyRule/Consent.policy",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "provision"
} ],
"max": "0",
"id": "Consent.provision",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision"
},
"isSummary": true
}, {
"path": "Consent.provision.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.provision.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.provision.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.provision.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.provision.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.provision.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower or equal value than end",
"source": "http://hl7.org/fhir/StructureDefinition/Period",
"severity": "error",
"expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())"
} ],
"path": "Consent.provision.period",
"min": 0,
"definition": "Timeframe for this provision.",
"isModifier": false,
"short": "Timeframe for this provision",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
}, {
"map": "CON-14&15 (Consent Effective Date Time, Consent End DateTime)",
"identity": "v2"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.provision.period",
"comment": "This is the bound effective time of the consent and should be in the base provision in the Consent resource.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.provision.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.provision.actor",
"min": 0,
"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').",
"isModifier": false,
"short": "Who|what controlled by this provision (or group, by role)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"meaningWhenMissing": "There is no specific actor associated with the exception",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "provisionActor"
} ],
"max": "*",
"id": "Consent.provision.actor",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.actor"
},
"isSummary": false
}, {
"path": "Consent.provision.actor.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.provision.actor.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.provision.actor.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.provision.actor.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.provision.actor.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.provision.actor.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.provision.actor.role",
"min": 0,
"definition": "How the individual is involved in the resources content that is described in the exception.",
"isModifier": false,
"short": "How the actor is involved",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/participation-role-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentActorRole"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "How an actor is involved in the consent considerations."
},
"max": "1",
"id": "Consent.provision.actor.role",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.provision.actor.role"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.provision.actor.reference",
"min": 0,
"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').",
"isModifier": false,
"short": "Resource for the actor (or group, by role)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.provision.actor.reference",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.provision.actor.reference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.provision.action",
"min": 0,
"definition": "Actions controlled by this provision.",
"isModifier": false,
"short": "Actions controlled by this provision",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"meaningWhenMissing": "all actions",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-action",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentAction"
} ],
"description": "Detailed codes for the consent action."
},
"max": "*",
"id": "Consent.provision.action",
"comment": "Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.action"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "Consent.provision.securityLabel",
"min": 0,
"definition": "A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.",
"isModifier": false,
"short": "Security Labels that define affected resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/security-label-examples",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Example Security Labels from the Healthcare Privacy and Security Classification System."
},
"max": "*",
"id": "Consent.provision.securityLabel",
"comment": "If the consent specifies a security label of \"R\" then it applies to all resources that are labeled \"R\" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.securityLabel"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "Consent.provision.purpose",
"min": 0,
"definition": "The context of the activities a user is taking - why the user is accessing the data - that are controlled by this provision.",
"isModifier": false,
"short": "Context of activities covered by this provision",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PurposeOfUse"
} ],
"description": "What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels."
},
"max": "*",
"id": "Consent.provision.purpose",
"comment": "When the purpose of use tag is on the data, access request purpose of use shall not conflict.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.purpose"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "Consent.provision.documentType",
"min": 0,
"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.",
"isModifier": false,
"short": "e.g. Resource Type, Profile, CDA, etc",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-content-class",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentClass"
} ],
"description": "The document type a consent provision covers."
},
"max": "*",
"id": "Consent.provision.documentType",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.documentType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "cod-1",
"human": "A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text",
"source": "http://hl7.org/fhir/StructureDefinition/Coding",
"severity": "warning",
"expression": "code.exists().not() implies display.exists().not()"
} ],
"path": "Consent.provision.resourceType",
"min": 0,
"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.",
"isModifier": false,
"short": "e.g. Resource Type, Profile, etc",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentClass"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The resource types a consent provision covers."
},
"max": "*",
"id": "Consent.provision.resourceType",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.resourceType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.provision.code",
"min": 0,
"definition": "If this code is found in an instance, then the provision applies.",
"isModifier": false,
"short": "e.g. LOINC or SNOMED CT code, etc. in the content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-content-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentContentCode"
} ],
"description": "If this code is found in an instance, then the exception applies."
},
"max": "*",
"id": "Consent.provision.code",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower or equal value than end",
"source": "http://hl7.org/fhir/StructureDefinition/Period",
"severity": "error",
"expression": "start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())"
} ],
"path": "Consent.provision.dataPeriod",
"min": 0,
"definition": "Clinical or Operational Relevant period of time that bounds the data controlled by this provision.",
"isModifier": false,
"short": "Timeframe for data controlled by this provision",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.provision.dataPeriod",
"comment": "This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.",
"base": {
"max": "1",
"min": 0,
"path": "Consent.provision.dataPeriod"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.provision.data",
"min": 0,
"definition": "The resources controlled by this provision if specific resources are referenced.",
"isModifier": false,
"short": "Data controlled by this provision",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"meaningWhenMissing": "all data",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "provisionData"
} ],
"max": "*",
"id": "Consent.provision.data",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.data"
},
"isSummary": true
}, {
"path": "Consent.provision.data.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.provision.data.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.provision.data.extension",
"min": 0,
"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.",
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Consent.provision.data.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Consent.provision.data.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Consent.provision.data.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Consent.provision.data.meaning",
"min": 1,
"definition": "How the resource reference is interpreted when testing consent restrictions.",
"isModifier": false,
"short": "instance | related | dependents | authoredby",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConsentDataMeaning"
} ],
"description": "How a resource reference is interpreted when testing consent restrictions."
},
"max": "1",
"id": "Consent.provision.data.meaning",
"comment": "Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size",
"base": {
"max": "1",
"min": 1,
"path": "Consent.provision.data.meaning"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))"
}, {
"key": "ref-2",
"human": "At least one of reference, identifier and display SHALL be present (unless an extension is provided).",
"source": "http://hl7.org/fhir/StructureDefinition/Reference",
"severity": "error",
"expression": "reference.exists() or identifier.exists() or display.exists() or extension.exists()"
} ],
"path": "Consent.provision.data.reference",
"min": 1,
"definition": "A reference to a specific resource that defines which resources are covered by this consent.",
"isModifier": false,
"short": "The actual data reference",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.provision.data.reference",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 1,
"path": "Consent.provision.data.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "exp-2",
"human": "The name must be a valid variable name in most computer languages",
"source": "http://hl7.org/fhir/StructureDefinition/Expression",
"severity": "error",
"expression": "name.hasValue() implies name.matches('[A-Za-z][A-Za-z0-9\\\\_]{0,63}')"
}, {
"key": "exp-1",
"human": "An expression or a reference must be provided",
"source": "http://hl7.org/fhir/StructureDefinition/Expression",
"severity": "error",
"expression": "expression.exists() or reference.exists()"
} ],
"path": "Consent.provision.expression",
"min": 0,
"definition": "A computable (FHIRPath or other) definition of what is controlled by this consent.",
"isModifier": false,
"short": "A computable expression of the consent",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Expression"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"max": "1",
"id": "Consent.provision.expression",
"comment": "Constraining the expression type for a specific implementation via profile is recommended",
"base": {
"max": "1",
"min": 0,
"path": "Consent.provision.expression"
},
"isSummary": false
}, {
"path": "Consent.provision.provision",
"min": 0,
"definition": "Provisions which provide exceptions to the base provision or subprovisions.",
"isModifier": false,
"short": "Nested Exception Provisions",
"contentReference": "http://hl7.org/fhir/StructureDefinition/Consent#Consent.provision",
"mustSupport": false,
"max": "*",
"id": "Consent.provision.provision",
"base": {
"max": "*",
"min": 0,
"path": "Consent.provision.provision"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "1fcb528a-3dac-4f95-ba98-cc81349fdda5",
"kind": "resource",
"url": "https://example.org/fhir/StructureDefinition/Consent",
"version": null,
"differential": {
"element": [ {
"id": "Consent.text",
"max": "0",
"path": "Consent.text"
}, {
"id": "Consent.identifier",
"max": "0",
"path": "Consent.identifier"
}, {
"id": "Consent.status",
"path": "Consent.status",
"fixedCode": "active"
}, {
"id": "Consent.category",
"max": "1",
"min": 1,
"path": "Consent.category"
}, {
"id": "Consent.category.coding",
"min": 1,
"path": "Consent.category.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "code",
"type": "value"
} ]
}
}, {
"id": "Consent.category.coding:342151000000109",
"max": "1",
"min": 1,
"path": "Consent.category.coding",
"sliceName": "342151000000109"
}, {
"id": "Consent.category.coding:342151000000109.system",
"min": 1,
"path": "Consent.category.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Consent.category.coding:342151000000109.version",
"max": "0",
"path": "Consent.category.coding.version"
}, {
"id": "Consent.category.coding:342151000000109.code",
"min": 1,
"path": "Consent.category.coding.code",
"fixedCode": "342151000000109"
}, {
"id": "Consent.category.coding:342151000000109.display",
"min": 1,
"path": "Consent.category.coding.display"
}, {
"id": "Consent.category.coding:342151000000109.userSelected",
"max": "0",
"path": "Consent.category.coding.userSelected"
}, {
"id": "Consent.category.coding:704498007",
"max": "1",
"min": 1,
"path": "Consent.category.coding",
"sliceName": "704498007"
}, {
"id": "Consent.category.coding:704498007.system",
"min": 1,
"path": "Consent.category.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Consent.category.coding:704498007.version",
"max": "0",
"path": "Consent.category.coding.version"
}, {
"id": "Consent.category.coding:704498007.code",
"min": 1,
"path": "Consent.category.coding.code",
"fixedCode": "704498007"
}, {
"id": "Consent.category.coding:704498007.display",
"min": 1,
"path": "Consent.category.coding.display"
}, {
"id": "Consent.category.coding:704498007.userSelected",
"max": "0",
"path": "Consent.category.coding.userSelected"
}, {
"id": "Consent.category.text",
"max": "0",
"path": "Consent.category.text"
}, {
"id": "Consent.subject",
"min": 1,
"path": "Consent.subject"
}, {
"id": "Consent.subject.reference",
"min": 1,
"path": "Consent.subject.reference",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/Patient"
}, {
"id": "Consent.subject.type",
"min": 1,
"path": "Consent.subject.type",
"fixedUri": "Patient"
}, {
"id": "Consent.subject.identifier",
"max": "0",
"path": "Consent.subject.identifier"
}, {
"id": "Consent.subject.display",
"max": "0",
"path": "Consent.subject.display"
}, {
"id": "Consent.date",
"min": 1,
"path": "Consent.date"
}, {
"id": "Consent.period",
"max": "0",
"path": "Consent.period"
}, {
"id": "Consent.grantor",
"max": "1",
"min": 1,
"path": "Consent.grantor"
}, {
"id": "Consent.grantor.reference",
"min": 1,
"path": "Consent.grantor.reference",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/Patient"
}, {
"id": "Consent.grantor.type",
"min": 1,
"path": "Consent.grantor.type",
"fixedUri": "Patient"
}, {
"id": "Consent.grantor.identifier",
"max": "0",
"path": "Consent.grantor.identifier"
}, {
"id": "Consent.grantor.display",
"max": "0",
"path": "Consent.grantor.display"
}, {
"id": "Consent.grantee",
"max": "1",
"min": 1,
"path": "Consent.grantee"
}, {
"id": "Consent.grantee.reference",
"min": 1,
"path": "Consent.grantee.reference",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/Patient"
}, {
"id": "Consent.grantee.type",
"min": 1,
"path": "Consent.grantee.type",
"fixedUri": "Patient"
}, {
"id": "Consent.grantee.identifier",
"max": "0",
"path": "Consent.grantee.identifier"
}, {
"id": "Consent.grantee.display",
"max": "0",
"path": "Consent.grantee.display"
}, {
"id": "Consent.manager",
"max": "0",
"path": "Consent.manager"
}, {
"id": "Consent.controller",
"max": "0",
"path": "Consent.controller"
}, {
"id": "Consent.sourceAttachment",
"max": "0",
"path": "Consent.sourceAttachment"
}, {
"id": "Consent.sourceReference",
"max": "1",
"min": 1,
"path": "Consent.sourceReference"
}, {
"id": "Consent.sourceReference.reference",
"min": 1,
"path": "Consent.sourceReference.reference",
"fixedString": "https://api.products.ndp.scot/storage/digital-dermatology/StructureDefinition/QuestionnaireResponse"
}, {
"id": "Consent.sourceReference.type",
"min": 1,
"path": "Consent.sourceReference.type",
"fixedUri": "QuestionnaireResponse"
}, {
"id": "Consent.sourceReference.identifier",
"max": "0",
"path": "Consent.sourceReference.identifier"
}, {
"id": "Consent.sourceReference.display",
"max": "0",
"path": "Consent.sourceReference.display"
}, {
"id": "Consent.regulatoryBasis",
"max": "0",
"path": "Consent.regulatoryBasis"
}, {
"id": "Consent.policyBasis",
"max": "0",
"path": "Consent.policyBasis"
}, {
"id": "Consent.policyText",
"max": "0",
"path": "Consent.policyText"
}, {
"id": "Consent.verification",
"max": "0",
"path": "Consent.verification"
}, {
"id": "Consent.decision",
"min": 1,
"path": "Consent.decision",
"fixedCode": "permit"
}, {
"id": "Consent.provision",
"max": "0",
"path": "Consent.provision"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Consent"
}