| Australian Digital Health Agency FHIR Implementation Guide 1.0.0

Australian Digital Health Agency FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available versions.

#### StructureDefinition: ADHA Record of Consent from Australian Organ Donor Register - Detailed Descriptions

Definitions for the dh-consent-aodr-1 Profile.

1. Consent
Definition | Describes the organ and tissue donation decisions made by an individual as held on the Australian Organ Donor Register
Control | 0..*
Comments | Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.
2. Consent.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Consent.meta
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.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Consent.implicitRules
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.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Consent.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Comments | 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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Consent.text
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.
Control | 0..1
Type | Narrative
Alternate Names | narrativehtmlxhtmldisplay
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Consent.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resourcesanonymous resourcescontained resources
Comments | 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.
8. Consent.extension
Definition | An Extension
Control | 0..*
Type | Extension
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Consent.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
9. Consent.extension:dateInitialRegistration
SliceName | dateInitialRegistration
Definition | The date an individual first registered, for example in the context of an organ donor register this date is not updated if a consent decision or provision is changed.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(DateInitialRegistration) (Extension Type: dateTime)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Consent.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Consent.identifier
Definition | Unique identifier for this copy of the Consent Statement.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Must Support | true
Comments | 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.
Example | General:<valueIdentifier xmlns="http://hl7.org/fhir"> <system value="urn:ietf:rfc:3986"/> <value value="Local eCMS identifier"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Consent.status
Definition | Indicates the current state of this consent.
Control | 1..1
Binding | The codes SHALL be taken from ConsentState Indicates the state of the consent
Type | code
Is Modifier | true
Must Support | true
Requirements | The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.
Comments | 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.
Fixed Value | active
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Consent.scope
Definition | A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
Control | 1..1
Binding | The codes SHALL be taken from ConsentScopeCodes; other codes may be used where these codes are not suitable The four anticipated uses for the Consent Resource
Type | CodeableConcept
Is Modifier | true
Must Support | true
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://terminology.hl7.org/CodeSystem/consentscope"/> <code value="adr"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Consent.category
Definition | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
Control | 1..*
Binding | The codes SHALL be taken from ConsentCategoryCodes; other codes may be used where these codes are not suitable A classification of the type of consents found in a consent statement
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Consent.category. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
15. Consent.category:health
SliceName | health
Definition | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
Control | 1..1
Binding | The codes SHALL be taken from ConsentCategoryCodes; other codes may be used where these codes are not suitable A classification of the type of consents found in a consent statement
Type | CodeableConcept
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="59284-0"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Consent.category:aodr
SliceName | aodr
Definition | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
Control | 1..1
Binding | The codes SHALL be taken from ConsentCategoryCodes; other codes may be used where these codes are not suitable A classification of the type of consents found in a consent statement
Type | CodeableConcept
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="64300-7"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Consent.patient
Definition | The patient/healthcare consumer to whom this consent applies.
Control | 1..1 This element is affected by the following invariants: inv-dh-cons-aodr-01
Type | Reference(ADHAPatientCore))
Must Support | true
Comments | Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-cons-aodr-01: At least reference or a valid identifier shall be present (: reference.exists() or identifier.where(system.count() + value.count() >1).exists())
18. Consent.dateTime
Definition | When this Consent was issued / created / indexed.
Control | 1..1 This element is affected by the following invariants: inv-dh-cons-aodr-03
Type | dateTime
Must Support | true
Comments | This is not the time of the original consent, but the time that this statement was made or derived.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-cons-aodr-03: Date shall be at least to day (: toString().length() >= 10)
19. Consent.performer
Definition | The entity responsible for granting the rights listed in a consent record.
Control | 1..1 This element is affected by the following invariants: inv-dh-cons-aodr-04
Type | Reference(ADHAPatientCore))
Must Support | true
Alternate Names | consentor
Comments | In the context of the Australian Organ Donor Register, the patient is the grantor of consent.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-cons-aodr-04: At least reference or a valid identifier shall be present (: reference.exists() or identifier.where(system.count() + value.count() >1).exists())
20. Consent.organization
Definition | The organization that manages the consent, and the framework within which it is executed.
Control | 1..1 This element is affected by the following invariants: inv-dh-cons-aodr-05
Type | Reference(ADHAOrganizationCore))
Must Support | true
Alternate Names | custodian
Comments | This consent record is managed by Services Australia via the Medicare Australia repository services operator.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-cons-aodr-05: At least reference or display or a valid identifier shall be present (: reference.exists() or display.exists() or identifier.where(system.count() + value.count() >1).exists())
21. Consent.source[x]
Definition | The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
Control | 0..1
Type | Choice of: Attachment, Reference(Consent DocumentReference Contract QuestionnaireResponse))
[x] Note | See Choice of Data Types for further information about how to use [x]
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Consent.policy
Definition | The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
Control | 1..1
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Consent.policy.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
24. Consent.policy.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. Consent.policy.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
26. Consent.policy.authority
Definition | Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
Control | 0..1 This element is affected by the following invariants: ppc-1
Type | uri
Must Support | true
Fixed Value | http://australianorgandonorregister.gov.au
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Consent.policy.uri
Definition | The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
Control | 1..1 This element is affected by the following invariants: ppc-1
Type | uri
Must Support | true
Comments | This element is for discoverability / documentation and does not modify or qualify the policy rules.
Fixed Value | http://www.australianorgandonorregister.gov.au/aodr
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Consent.policyRule
Definition | A reference to the specific base computable regulation or policy.
Control | 0..1 This element is affected by the following invariants: ppc-1
Binding | The codes SHALL be taken from ConsentPolicyRuleCodes; other codes may be used where these codes are not suitable Regulatory policy examples
Type | CodeableConcept
Requirements | Might be a unique identifier of a policy set in XACML, or other rules engine.
Comments | If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Consent.verification
Definition | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
Control | 0..*
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Consent.verification.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
31. Consent.verification.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
32. Consent.verification.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. Consent.verification.verified
Definition | Has the instruction been verified.
Control | 1..1
Type | boolean
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Consent.verification.verifiedWith
Definition | Who verified the instruction (Patient, Relative or other Authorized Person).
Control | 0..1
Type | Reference(Patient RelatedPerson))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Consent.verification.verificationDate
Definition | Date verification was collected.
Control | 0..1
Type | dateTime
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Consent.provision
Definition | Individual's decision about donation.
Control | 1..1 This element is affected by the following invariants: inv-dh-cons-aodr-02
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dh-cons-aodr-02: Specific provisions shall be specified if the individual is willing to donate, otherwise prohibited (: provision.exists() xor (type='deny'))
37. Consent.provision.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
38. Consent.provision.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. Consent.provision.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
40. Consent.provision.type
Definition | Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
Control | 1..1
Binding | The codes SHALL be taken from ConsentProvisionType How a rule statement is applied, such as adding additional consent or removing consent
Type | code
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Consent.provision.period
Definition | The timeframe in this rule is valid.
Control | 0..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Consent.provision.actor
Definition | Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
Control | 0..*
Type | BackboneElement
Meaning if Missing | There is no specific actor associated with the exception
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Consent.provision.actor.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
44. Consent.provision.actor.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
45. Consent.provision.actor.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
46. Consent.provision.actor.role
Definition | How the individual is involved in the resources content that is described in the exception.
Control | 1..1
Binding | The codes SHALL be taken from SecurityRoleType; other codes may be used where these codes are not suitable How an actor is involved in the consent considerations
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Consent.provision.actor.reference
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').
Control | 1..1
Type | Reference(Device Group CareTeam Organization Patient Practitioner RelatedPerson PractitionerRole))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Consent.provision.action
Definition | Actions controlled by this Rule.
Control | 1..1
Binding | For example codes, see ConsentActionCodes Detailed codes for the consent action
Type | CodeableConcept
Must Support | true
Comments | 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'.
Meaning if Missing | all actions
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://snomed.info/sct"/> <code value="53958007"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Consent.provision.securityLabel
Definition | A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
Control | 0..*
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
Type | Coding
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Consent.provision.purpose
Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
Control | 0..*
Binding | The codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
Type | Coding
Comments | When the purpose of use tag is on the data, access request purpose of use shall not conflict.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Consent.provision.class
Definition | The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
Control | 0..*
Binding | The codes SHALL be taken from ConsentContentClass; other codes may be used where these codes are not suitable The class (type) of information a consent rule covers
Type | Coding
Comments | Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Consent.provision.code
Definition | If this code is found in an instance, then the rule applies.
Control | 0..*
Binding | For example codes, see ConsentContentCodes If this code is found in an instance, then the exception applies
Type | CodeableConcept
Comments | Typical use of this is a Document code with class = CDA.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Consent.provision.dataPeriod
Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
Control | 0..1
Type | Period
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Consent.provision.data
Definition | The resources controlled by this rule if specific resources are referenced.
Control | 0..*
Type | BackboneElement
Meaning if Missing | all data
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. Consent.provision.data.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
56. Consent.provision.data.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
57. Consent.provision.data.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
58. Consent.provision.data.meaning
Definition | How the resource reference is interpreted when testing consent restrictions.
Control | 1..1
Binding | The codes SHALL be taken from ConsentDataMeaning How a resource reference is interpreted when testing consent restrictions
Type | code
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Consent.provision.data.reference
Definition | A reference to a specific resource that defines which resources are covered by this consent.
Control | 1..1
Type | Reference(Resource))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Consent.provision.provision
Definition | Individual's decision about donation of specific organ or tissue.
Control | 0..*
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Consent.provision.provision.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
62. Consent.provision.provision.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
63. Consent.provision.provision.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
64. Consent.provision.provision.type
Definition | Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.
Control | 1..1
Binding | The codes SHALL be taken from ConsentProvisionType How a rule statement is applied, such as adding additional consent or removing consent
Type | code
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Consent.provision.provision.period
Definition | The timeframe in this rule is valid.
Control | 0..1
Type | Period
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. Consent.provision.provision.actor
Definition | Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
Control | 0..*
Type | BackboneElement
Meaning if Missing | There is no specific actor associated with the exception
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. Consent.provision.provision.actor.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
68. Consent.provision.provision.actor.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
69. Consent.provision.provision.actor.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
70. Consent.provision.provision.actor.role
Definition | How the individual is involved in the resources content that is described in the exception.
Control | 1..1
Binding | The codes SHALL be taken from SecurityRoleType; other codes may be used where these codes are not suitable How an actor is involved in the consent considerations
Type | CodeableConcept
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. Consent.provision.provision.actor.reference
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').
Control | 1..1
Type | Reference(Device Group CareTeam Organization Patient Practitioner RelatedPerson PractitionerRole))
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Consent.provision.provision.action
Definition | Actions controlled by this Rule.
Control | 1..1
Binding | For example codes, see ConsentActionCodes Detailed codes for the consent action
Type | CodeableConcept
Must Support | true
Comments | 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'.
Meaning if Missing | all actions
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://snomed.info/sct"/> <code value="53958007"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Consent.provision.provision.securityLabel
Definition | A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.
Control | 0..*
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
Type | Coding
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Consent.provision.provision.purpose
Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.
Control | 0..*
Binding | The codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels
Type | Coding
Comments | When the purpose of use tag is on the data, access request purpose of use shall not conflict.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Consent.provision.provision.class
Definition | The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
Control | 0..*
Binding | The codes SHALL be taken from ConsentContentClass; other codes may be used where these codes are not suitable The class (type) of information a consent rule covers
Type | Coding
Comments | Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. Consent.provision.provision.code
Definition | If this code is found in an instance, then the rule applies.
Control | 0..*
Binding | For example codes, see ConsentContentCodes If this code is found in an instance, then the exception applies
Type | CodeableConcept
Comments | Typical use of this is a Document code with class = CDA.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. Consent.provision.provision.dataPeriod
Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this rule.
Control | 0..1
Type | Period
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. Consent.provision.provision.data
Definition | The organ or tissue that is the target of the donation decision.
Control | 1..1
Type | BackboneElement
Must Support | true
Meaning if Missing | all data
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. Consent.provision.provision.data.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
80. Consent.provision.provision.data.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
81. Consent.provision.provision.data.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
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.
Alternate Names | extensionsuser contentmodifiers
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
82. Consent.provision.provision.data.meaning
Definition | How the resource reference is interpreted when testing consent restrictions.
Control | 1..1
Binding | The codes SHALL be taken from ConsentDataMeaning How a resource reference is interpreted when testing consent restrictions
Type | code
Fixed Value | instance
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
83. Consent.provision.provision.data.reference
Definition | A reference to a specific resource that defines which resources are covered by this consent.
Control | 1..1
Type | Reference(ADHABodyStructureAODR))
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
84. Consent.provision.provision.data.reference.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
85. Consent.provision.provision.data.reference.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensionsuser content
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Consent.provision.provision.data.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
86. Consent.provision.provision.data.reference.reference
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.
Control | 1..1 This element is affected by the following invariants: ref-1
Type | string
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. Consent.provision.provision.data.reference.type
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. The 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).
Control | 0..1
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model)
Type | uri
Comments | 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 RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. Consent.provision.provision.data.reference.identifier
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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference 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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
89. Consent.provision.provision.data.reference.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Control | 0..1
Type | string
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. Consent.provision.provision.provision
Definition | Rules which provide exceptions to the base rule or subrules.
Control | 0..*
Type | See ttp://hl7.org/fhir/StructureDefinition/Consent#Consent.provision
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))