Consent
The FHIR resource Consent is for Immunization Consent for antigens.
| Consent | C | Consent | |
| id | Σ | 1..1 | string |
| meta | Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 1..1 | canonical(StructureDefinition) |
| security | Σ | 0..1 | CodingBinding |
| tag | Σ | 0..1 | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 1..* | PractitionerConsentGivenTo, RelatedPerson | |
| extension | C | 2..* | Extension |
| consentExtension | C | 0..* | Extension(Complex) |
| id | 0..1 | string | |
| extension | C | 3..* | Extension |
| PIRconsentDirectiveCategory | C | 1..1 | Extension |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| PIRconsentDirectiveSubCategory | C | 1..1 | Extension |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| PIRconsentDirectiveType | C | 1..1 | Extension |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| consentDirectiveDoses | C | 0..1 | Extension |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| consentDirectiveForm | C | 0..1 | Extension |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| consentDirectiveComments | C | 0..* | Extension |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | Annotation | |
| id | 0..0 | string | |
| extension | C | 2..* | Extension |
| pIRIdentifierExtension | C | 1..1 | Extension(string) |
| pIRLockSeqNumberExtension | C | 1..1 | Extension(integer) |
| author[x] | Σ | 0..0 | |
| time | Σ | 0..1 | dateTime |
| text | Σ | 1..1 | markdown |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..0 | ||
| pIRIdentifierExtension | C | 1..1 | Extension(string) |
| pIRLockSeqNumberExtension | C | 1..1 | Extension(integer) |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | Σ | 1..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..1 | Coding |
| text | Σ | 1..1 | string |
| system | Σ | 1..1 | uri |
| value | Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| status | Σ ?! | 1..1 | codeBinding |
| scope | Σ ?! | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| category | Σ | 1..* | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| patient | Σ C | 0..1 | Reference(Patient) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| dateTime | Σ | 0..1 | dateTime |
| performer | Σ C | 0..1 | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| organization | Σ C | 0..1 | Reference(Organization) |
| source[x] | Σ | 0..1 | |
| sourceAttachment | Attachment | ||
| sourceReference | Reference(Consent | Contract | DocumentReference | QuestionnaireResponse) | ||
| policy | 0..1 | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| authority | C | 0..1 | uri |
| uri | C | 0..1 | uri |
| policyRule | Σ C | 1..1 | CodeableConceptBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| verification | Σ | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| verified | Σ | 1..1 | boolean |
| verifiedWith | C | 0..1 | Reference(Patient | RelatedPerson) |
| verificationDate | 0..1 | dateTime | |
| provision | Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| type | Σ | 0..1 | codeBinding |
| period | Σ C | 1..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | Σ C | 1..1 | dateTime |
| end | Σ C | 0..1 | dateTime |
| actor | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| role | 1..1 | CodeableConceptBinding | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 1..1 | code |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| reference | C | 1..1 | Reference(CareTeam | Device | Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| action | Σ | 1..1 | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| sliceConsentInstruction | Σ | 1..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 1..1 | code |
| display | Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| sliceConsentRefusalReaason | Σ | 0..1 | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 1..1 | code |
| display | Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| securityLabel | Σ | 0..1 | CodingBinding |
| purpose | Σ | 0..1 | CodingBinding |
| class | Σ | 0..1 | CodingBinding |
| code | Σ | 1..* | CodeableConcept |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 1..* | Coding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 1..1 | code |
| display | Σ | 1..1 | string |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| dataPeriod | Σ C | 0..1 | Period |
| data | Σ | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| meaning | Σ | 1..1 | codeBinding |
| reference | Σ C | 1..1 | Reference(Resource) |
| provision | 0..1 | see (provision) |
| Consent | |||
| Short | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||
| Definition | A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time. | ||
| Cardinality | 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. | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | See Mappings | ||
| Mappings |
| ||
| Consent.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.meta.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.meta.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.meta.versionId | |||
| Short | Version specific identifier | ||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | Apply "2025.01.1". This indicates the FHIR Specs as of year 2025 Jan. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.meta.lastUpdated | |||
| Short | When the resource version last changed | ||
| Definition | When the resource last changed - e.g. when the version changed. | ||
| Cardinality | 0..1 | ||
| Type | instant | ||
| Summary | True | ||
| Comments | Updated: Relax the previously crossed-out elements. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.meta.source | |||
| Short | Identifies where the resource comes from | ||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Summary | True | ||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.meta.profile | |||
| Short | Profiles this resource claims to conform to | ||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||
| Cardinality | 1..1 | ||
| Type | canonical(StructureDefinition) | ||
| Summary | True | ||
| Comments | Apply "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Consent" | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.meta.security | |||
| Short | Security Labels applied to this resource | ||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
| Summary | True | ||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.meta.tag | |||
| Short | Tags applied to this resource | ||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||
| Summary | True | ||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
| Cardinality | 0..1 | ||
| Type | Narrative | ||
| Alias | narrative, html, xhtml, display | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.contained | |||
| Short | Contained, inline Resources | ||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
| Cardinality | 1..* | ||
| Type | PractitionerConsentGivenTo, RelatedPerson | ||
| Alias | inline resources, anonymous resources, contained 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. | ||
| Mappings |
| ||
| Consent.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 2..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension | |||
| Short | Optional Extensions Element | ||
| Definition | Optional Extension Element - found in all resources. | ||
| Cardinality | 0..* | ||
| Type | Extension(Complex) | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 3..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveCategory | |||
| Short | PIR Consent Directive Cateogry | ||
| Definition | PIR Consent Directive Cateogry | ||
| Cardinality | 1..1 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveCategory.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveCategory.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveCategory.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | PIRconsentDirectiveCategory | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveCategory.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveSubCategory | |||
| Short | PIR Consent Directive Sub-Category | ||
| Definition | PIR Consent Directive Sub-Category | ||
| Cardinality | 1..1 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveSubCategory.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveSubCategory.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveSubCategory.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | PIRconsentDirectiveSubCategory | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveSubCategory.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveType | |||
| Short | PIR Consent Directive Type | ||
| Definition | PIR Consent Directive Type | ||
| Cardinality | 1..1 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveType.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveType.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveType.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | PIRconsentDirectiveType | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:PIRconsentDirectiveType.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveDoses | |||
| Short | Consent for No. of Doses | ||
| Definition | Consent for No. of Doses | ||
| Cardinality | 0..1 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveDoses.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveDoses.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveDoses.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | consentDirectiveDoses | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveDoses.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveForm | |||
| Short | PIR Directive Form of Consent | ||
| Definition | PIR Directive Form of Consent | ||
| Cardinality | 0..1 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveForm.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveForm.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveForm.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | consentDirectiveForm | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveForm.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | In Person | Telephone | Written. See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments | |||
| Short | Consent Directive Comments | ||
| Definition | Consent Directive Comments | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | consentDirectiveComments | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Annotation | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x].id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..0 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x].extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 2..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x].extension:pIRIdentifierExtension | |||
| Short | Optional Extensions Element | ||
| Definition | Optional Extension Element - found in all resources. | ||
| Cardinality | 1..1 | ||
| Type | Extension(string) | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x].extension:pIRLockSeqNumberExtension | |||
| Short | Optional Extensions Element | ||
| Definition | Optional Extension Element - found in all resources. | ||
| Cardinality | 1..1 | ||
| Type | Extension(integer) | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x].author[x] | |||
| Short | Individual responsible for the annotation | ||
| Definition | The individual responsible for making the annotation. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Organization | Patient | Practitioner | RelatedPerson) | string | ||
| Summary | True | ||
| Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x].time | |||
| Short | When the annotation was made | ||
| Definition | Indicates when this particular annotation was made. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Comments | List Comments Creation DateTime by descending order. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.extension:consentDirectiveComments.value[x].text | |||
| Short | The annotation - text content (as markdown) | ||
| Definition | The text of the annotation in markdown format. | ||
| Cardinality | 1..1 | ||
| Type | markdown | ||
| Summary | True | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:consentExtension.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/consent-type-form-doses-comments | ||
| Mappings |
| ||
| Consent.extension:consentExtension.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..0 | ||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:pIRIdentifierExtension | |||
| Short | Optional Extensions Element | ||
| Definition | Optional Extension Element - found in all resources. | ||
| Cardinality | 1..1 | ||
| Type | Extension(string) | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.extension:pIRLockSeqNumberExtension | |||
| Short | Optional Extensions Element | ||
| Definition | Optional Extension Element - found in all resources. | ||
| Cardinality | 1..1 | ||
| Type | Extension(integer) | ||
| Alias | extensions, user 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Alias | extensions, user content | ||
| 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. | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier | |||
| Short | Identifier for this record (external references) | ||
| Definition | Unique identifier for this copy of the Consent Statement. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General{
"system": "urn:ietf:rfc:3986",
"value": "Local eCMS identifier"
} | ||
| Mappings |
| ||
| Consent.identifier.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.identifier.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| Definition | The purpose of this identifier. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the purpose for this identifier, if known . | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier.type | |||
| Short | Description of identifier | ||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
| Summary | True | ||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier.type.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.identifier.type.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier.type.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier.type.text | |||
| Short | Plain text representation of the concept | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier.system | |||
| Short | The namespace for the identifier value | ||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Consent.identifier.value | |||
| Short | The value that is unique | ||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Consent.identifier.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | 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"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.identifier.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| Definition | Organization that issued/manages the identifier. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.status | |||
| Short | draft | proposed | active | rejected | inactive | entered-in-error | ||
| Definition | Indicates the current state of this consent. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | Indicates the state of the consent. | ||
| Modifier | True | ||
| Summary | True | ||
| Requirements | The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive. | ||
| Comments | Confirmed (PIR) maps to Active (FHIR). See Mappings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope | |||
| Short | Which of the four areas this resource covers (extensible) | ||
| Definition | A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | The four anticipated uses for the Consent Resource. | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.scope.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.scope.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.coding.system | |||
| Short | Identity of the terminology system | ||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
| Comments | See Code | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.coding.version | |||
| Short | Version of the system - if relevant | ||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Apply "treatment" | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.coding.display | |||
| Short | Representation defined by the system | ||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Summary | True | ||
| 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.scope.text | |||
| Short | Plain text representation of the concept | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category | |||
| Short | Classification of the consent statement - for indexing/retrieval | ||
| Definition | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. | ||
| Cardinality | 1..* | ||
| Type | CodeableConcept | ||
| Binding | A classification of the type of consents found in a consent statement. | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.category.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 0..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.category.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.coding.system | |||
| Short | Identity of the terminology system | ||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
| Comments | See Code | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.coding.version | |||
| Short | Version of the system - if relevant | ||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Apply "59284-0" | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.coding.display | |||
| Short | Representation defined by the system | ||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Summary | True | ||
| 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.category.text | |||
| Short | Plain text representation of the concept | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.patient | |||
| Short | Who the consent applies to | ||
| Definition | The patient/healthcare consumer to whom this consent applies. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Patient) | ||
| Summary | True | ||
| Comments | Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.patient.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.patient.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.patient.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.patient.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.patient.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.patient.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.dateTime | |||
| Short | When this Consent was created or indexed | ||
| Definition | When this Consent was issued / created / indexed. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Comments | This is not the time of the original consent, but the time that this statement was made or derived. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.performer | |||
| Short | Who is agreeing to the policy and rules | ||
| Definition | Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Summary | True | ||
| Alias | consentor | ||
| Comments | Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.performer.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.performer.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.performer.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.performer.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.performer.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.performer.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.organization | |||
| Short | Custodian of the consent | ||
| Definition | The organization that manages the consent, and the framework within which it is executed. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Summary | True | ||
| Alias | custodian | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.source[x] | |||
| Short | Source from which this consent is taken | ||
| Definition | The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document. | ||
| Cardinality | 0..1 | ||
| Type | Attachment | Reference(Consent | Contract | DocumentReference | QuestionnaireResponse) | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policy | |||
| Short | Policies covered by this consent | ||
| Definition | The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policy.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.policy.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policy.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policy.authority | |||
| Short | Enforcement source for policy | ||
| Definition | Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ppc-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policy.uri | |||
| Short | Specific policy covered by this consent | ||
| Definition | The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Comments | This element is for discoverability / documentation and does not modify or qualify the policy rules. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ppc-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule | |||
| Short | Regulation that this consents to | ||
| Definition | A reference to the specific base computable regulation or policy. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Regulatory policy examples. | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ppc-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.policyRule.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.policyRule.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.coding.system | |||
| Short | Identity of the terminology system | ||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
| Comments | See Code | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.coding.version | |||
| Short | Version of the system - if relevant | ||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Apply "cric" (Common Rule Informed Consent). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.coding.display | |||
| Short | Representation defined by the system | ||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Summary | True | ||
| 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.policyRule.text | |||
| Short | Plain text representation of the concept | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.verification | |||
| Short | Consent Verified by patient or family | ||
| Definition | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.verification.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.verification.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.verification.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.verification.verified | |||
| Short | Has been verified | ||
| Definition | Has the instruction been verified. | ||
| Cardinality | 1..1 | ||
| Type | boolean | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.verification.verifiedWith | |||
| Short | Person who verified | ||
| Definition | Who verified the instruction (Patient, Relative or other Authorized Person). | ||
| Cardinality | 0..1 | ||
| Type | Reference(Patient | RelatedPerson) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.verification.verificationDate | |||
| Short | When consent verified | ||
| Definition | Date verification was collected. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision | |||
| Short | Constraints to the base Consent.policyRule | ||
| Definition | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.type | |||
| Short | deny | permit | ||
| Definition | Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | How a rule statement is applied, such as adding additional consent or removing consent. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.period | |||
| Short | Timeframe for this rule | ||
| Definition | The timeframe in this rule is valid. | ||
| Cardinality | 1..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | 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"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.period.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.period.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.period.start | |||
| Short | Starting time with inclusive boundary | ||
| Definition | The start of the period. The boundary is inclusive. | ||
| Cardinality | 1..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Comments | See Mappings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, per-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.period.end | |||
| Short | End time with inclusive boundary, if not ongoing | ||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Comments | See Mappings | ||
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, per-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor | |||
| Short | Who|what controlled by this rule (or group, by role) | ||
| Definition | Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers'). | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Meaning when missing | There is no specific actor associated with the exception | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.actor.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role | |||
| Short | How the actor is involved | ||
| Definition | How the individual is involved in the resources content that is described in the exception. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | How an actor is involved in the consent considerations. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.actor.role.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.actor.role.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.coding.system | |||
| Short | Identity of the terminology system | ||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
| Comments | 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 reference to some definition that establishes the system clearly and unambiguously. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.coding.version | |||
| Short | Version of the system - if relevant | ||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Apply "CONSENTER" | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.coding.display | |||
| Short | Representation defined by the system | ||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Summary | True | ||
| 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.role.text | |||
| Short | Plain text representation of the concept | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.reference | |||
| Short | Resource for the actor (or group, by role) | ||
| Definition | The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers'). | ||
| Cardinality | 1..1 | ||
| Type | Reference(CareTeam | Device | Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.reference.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.actor.reference.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.reference.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.reference.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.reference.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.actor.reference.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action | |||
| Short | Consent or Refusal | ||
| Definition | Consent or Refusal | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Detailed codes for the consent action. | ||
| Summary | 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 when missing | all actions | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.action.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Slicing | Unordered, Open, by system(Pattern), code(Pattern) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..1 | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction.system | |||
| Short | Identity of the terminology system | ||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
| Comments | See Code | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction.version | |||
| Short | Version of the system - if relevant | ||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction.code | |||
| Short | Symbol in syntax defined by the system | ||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | G | R. Refer to IMMS codeset spreadsheet: Consent - Instruction. See Mappings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction.display | |||
| Short | Representation defined by the system | ||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
| Comments | Grant | Refuse | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentInstruction.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Summary | True | ||
| 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason.system | |||
| Short | Identity of the terminology system | ||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
| Comments | See Code | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason.version | |||
| Short | Version of the system - if relevant | ||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason.code | |||
| Short | Symbol in syntax defined by the system | ||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Refer to IMMS codeset spreadsheet: Consent - Reason. See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason.display | |||
| Short | Representation defined by the system | ||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
| Comments | Refer to IMMS codeset spreadsheet: Consent - Reason | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.coding:sliceConsentRefusalReaason.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Summary | True | ||
| 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.action.text | |||
| Short | Plain text representation of the concept | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Comments | Mandatory if Reason for Refusal = "O"ther. See Mappings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.securityLabel | |||
| Short | Security Labels that define affected resources | ||
| Definition | A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Binding | Security Labels from the Healthcare Privacy and Security Classification System. | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.purpose | |||
| Short | Context of activities covered by this rule | ||
| Definition | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Binding | What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||
| Summary | True | ||
| Comments | When the purpose of use tag is on the data, access request purpose of use shall not conflict. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.class | |||
| Short | e.g. Resource Type, Profile, CDA, etc. | ||
| Definition | The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to. | ||
| Cardinality | 0..1 | ||
| Type | Coding | ||
| Binding | The class (type) of information a consent rule covers. | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code | |||
| Short | e.g. LOINC or SNOMED CT code, etc. in the content | ||
| Definition | If this code is found in an instance, then the rule applies. | ||
| Cardinality | 1..* | ||
| Type | CodeableConcept | ||
| Binding | If this code is found in an instance, then the exception applies. | ||
| Summary | True | ||
| Comments | Typical use of this is a Document code with class = CDA. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.code.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.coding | |||
| Short | Code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 1..* | ||
| Type | Coding | ||
| Summary | True | ||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.code.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.coding.system | |||
| Short | Identity of the terminology system | ||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Summary | True | ||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
| Comments | See Mappings | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.coding.version | |||
| Short | Version of the system - if relevant | ||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Summary | True | ||
| Requirements | Need to refer to a particular code in the system. | ||
| Comments | Enter Vaccine code for both consent and Consent Refussal. See Mappings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.coding.display | |||
| Short | Representation defined by the system | ||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
| Comments | Enter Vaccine Name for Consent or Consent Refussal | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Summary | True | ||
| 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.code.text | |||
| Short | Plain text representation of the concept | ||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.dataPeriod | |||
| Short | Timeframe for data controlled by this rule | ||
| Definition | Clinical or Operational Relevant period of time that bounds the data controlled by this rule. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.data | |||
| Short | Data controlled by this rule | ||
| Definition | The resources controlled by this rule if specific resources are referenced. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Meaning when missing | all data | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.data.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Consent.provision.data.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.data.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.data.meaning | |||
| Short | instance | related | dependents | authoredby | ||
| Definition | How the resource reference is interpreted when testing consent restrictions. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | How a resource reference is interpreted when testing consent restrictions. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.data.reference | |||
| Short | The actual data reference | ||
| Definition | A reference to a specific resource that defines which resources are covered by this consent. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Resource) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Consent.provision.provision | |||
| Short | Nested Exception Rules | ||
| Definition | Rules which provide exceptions to the base rule or subrules. | ||
| Cardinality | 0..1 | ||
| Type | see (provision) | ||