Consent
This resource represents the patient's consent to enroll into the HealthierSG program.
| profile-Consent-put-consent (Consent) | C | Consent | There are no (further) constraints on this element Element idConsentShort description A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time DefinitionA 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. 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.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idConsent.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idConsent.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idConsent.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idConsent.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). IETF language tag
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idConsent.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |||
| contained | C | 0..* | Resource | There are no (further) constraints on this element Element idConsent.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| ||
| extension | C | 2..2 | Extension | Element idConsent.extensionShort description n/a Alternate namesextensions, user content DefinitionAdditional data elements required by Healthier SG n/a The extension is in the format of key/value pair, where the key is specified in 'url' attribute, and the values is specified in the 'value[Type]' attribute, the type can be Coding, String , Date or others depending on the definition specified in data type column W All the extension url is be prefixed with "http://ihis.sg/extension" and followed by friendly short name Unordered, Open, by url(Value) Constraints
| ||
| provided-by | C | 1..1 | Extension(CodeableConcept) | Element idConsent.extension:provided-byShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a http://ihis.sg/extension/consent-provided-by ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| consent-authentication-mode | C | 1..1 | Extension(CodeableConcept) | Element idConsent.extension:consent-authentication-modeShort description n/a Alternate namesextensions, user content Definitionn/a n/a n/a http://ihis.sg/extension/consent-authentication-mode ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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.
| ||
| identifier | Σ | 0..0 | Identifier | Element idConsent.identifierShort description n/a Definitionn/a n/a n/a
| ||
| status | Σ ?! | 1..1 | codeBindingFixed Value | Element idConsent.statusShort description n/a DefinitionConsent status n/a Fixed Value: "active" Indicates the state of the consent.
activeMappings
| ||
| scope | Σ ?! | 1..1 | CodeableConceptBinding | Element idConsent.scopeShort description n/a DefinitionScope of the consent, fixed to "Onboard Healthier SG" n/a n/a The four anticipated uses for the Consent Resource. ConsentScopeCodes (extensible) Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idConsent.scope.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.scope.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | CodingBinding | Element idConsent.scope.codingShort description n/a DefinitionGrouping of coding n/a n/a http://ihis.sg/ValueSet/hsg-consent-scope (required) Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idConsent.scope.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.scope.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ C | 1..1 | uriFixed Value | Element idConsent.scope.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Fixed Value : "http://ihis.sg/ValueSet/hsg-consent-scope"
http://ihis.sg/ValueSet/hsg-consent-scopeMappings
| ||
| version | Σ | 0..0 | string | Element idConsent.scope.coding.versionShort description n/a Definitionn/a n/a n/a
| ||
| code | Σ C | 1..1 | code | Element idConsent.scope.coding.codeShort description n/a DefinitionThe code of the coding The code of the coding. It shall be one of the code defined in valueset "http://ihis.sg/ValueSet/hsg-consent-scope" n/a Sample Value : "onboard-healthier-sg"
| ||
| display | Σ C | 0..1 | string | Element idConsent.scope.coding.displayShort description n/a DefinitionRepresentation defined by the system n/a Sample Value : "Onboard Healthier SG"
| ||
| userSelected | Σ | 0..0 | boolean | Element idConsent.scope.coding.userSelectedShort description n/a Definitionn/a n/a n/a
| ||
| text | Σ | 0..0 | string | Element idConsent.scope.textShort description n/a Definitionn/a n/a n/a
| ||
| category | Σ | 1..1 | CodeableConceptBinding | Element idConsent.categoryShort description n/a DefinitionExtension value set "http://ihis.sg/ValueSet/hsg-consent-category" n/a n/a A classification of the type of consents found in a consent statement. ConsentCategoryCodes (extensible) Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idConsent.category.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.category.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | CodingBinding | Element idConsent.category.codingShort description n/a DefinitionGrouping of coding n/a n/a http://ihis.sg/ValueSet/hsg-consent-category (required) Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idConsent.category.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.category.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ C | 1..1 | uriFixed Value | Element idConsent.category.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Fixed Value : "http://ihis.sg/ValueSet/hsg-consent-category"
http://ihis.sg/ValueSet/hsg-consent-categoryMappings
| ||
| version | Σ | 0..0 | string | Element idConsent.category.coding.versionShort description n/a Definitionn/a n/a n/a
| ||
| code | Σ C | 1..1 | code | Element idConsent.category.coding.codeShort description n/a DefinitionThe code of the coding The code of the coding. It shall be one of the code defined in valueset "http://ihis.sg/ValueSet/hsg-consent-category" n/a Sample Value : "healthiersg-consent"
| ||
| display | Σ C | 0..1 | string | Element idConsent.category.coding.displayShort description n/a DefinitionRepresentation defined by the system n/a Sample Value : "HealthierSG-Consent"
| ||
| userSelected | Σ | 0..0 | boolean | Element idConsent.category.coding.userSelectedShort description n/a Definitionn/a n/a n/a
| ||
| text | Σ | 0..0 | string | Element idConsent.category.textShort description n/a Definitionn/a n/a n/a
| ||
| patient | Σ | 1..1 | Reference(Patient) | Element idConsent.patientShort description n/a DefinitionReference to patient resource who give consent n/a n/a
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idConsent.patient.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.patient.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..0 | string | Element idConsent.patient.referenceShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ C | 1..1 | uriBinding | Element idConsent.patient.typeShort description n/a DefinitionThe resource reference type n/a Fixed Value: "Patient"
| ||
| identifier | Σ | 1..1 | Identifier | Element idConsent.patient.identifierShort description n/a Definitionn/a n/a n/a
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idConsent.patient.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.patient.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | Element idConsent.patient.identifier.useShort description n/a Definitionn/a n/a n/a
| ||
| type | Σ | 0..0 | CodeableConceptBinding | Element idConsent.patient.identifier.typeShort description n/a Definitionn/a n/a n/a Identifier Type Codes (extensible) Constraints
| ||
| system | Σ C | 1..1 | uriFixed Value | Element idConsent.patient.identifier.systemShort description n/a DefinitionDescription of identifier n/a Fixed Value: "http://ihis.sg/identifier/nric"
http://ihis.sg/identifier/nricExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ C | 1..1 | string | Element idConsent.patient.identifier.valueShort description n/a DefinitionThe namespace for the identifier value n/a Sample Value: "S1234567D"
General 123456Mappings
| ||
| period | Σ | 0..0 | Period | Element idConsent.patient.identifier.periodShort description n/a Definitionn/a n/a n/a
| ||
| assigner | Σ | 0..0 | Reference(Organization) | Element idConsent.patient.identifier.assignerShort description n/a Definitionn/a n/a n/a
| ||
| display | Σ | 0..0 | string | Element idConsent.patient.displayShort description n/a Definitionn/a n/a n/a
| ||
| dateTime | Σ C | 1..1 | dateTime | Element idConsent.dateTimeShort description n/a DefinitionWhen this Consent was created or indexed n/a Sample Value: "2022-09-09T09:44:32+08:00" , "2023-05-03T18:18:38.358+08:00"
| ||
| performer | Σ | 0..0 | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Element idConsent.performerShort description n/a Alternate namesconsentor Definitionn/a n/a n/a Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Constraints
| ||
| organization | Σ | 0..0 | Reference(Organization) | Element idConsent.organizationShort description n/a Alternate namescustodian Definitionn/a n/a n/a
| ||
| source[x] | Σ | 0..0 | Element idConsent.source[x]Short description n/a Definitionn/a n/a n/a
| |||
| policy | 1..1 | BackboneElement | Element idConsent.policyShort description n/a DefinitionPolicy that covered by this consent n/a n/a
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idConsent.policy.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idConsent.policy.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
| ||
| authority | C | 0..0 | uri | Element idConsent.policy.authorityShort description n/a Definitionn/a n/a n/a The cardinality or value of this element may be affected by these constraints: ppc-1 Constraints
| ||
| uri | C | 1..1 | uriFixed Value | Element idConsent.policy.uriShort description n/a DefinitionReference plan definition resource n/a Sample Value: "http://ihis.sg/PlanDefinition/healthier-sg/healthier-sg-programme" The cardinality or value of this element may be affected by these constraints: ppc-1 Constraints
http://ihis.sg/PlanDefinition/healthier-sg/healthier-sg-programme | ||
| policyRule | Σ C | 0..0 | CodeableConceptBinding | Element idConsent.policyRuleShort description n/a Definitionn/a n/a n/a Regulatory policy examples. ConsentPolicyRuleCodes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ppc-1 Constraints
| ||
| verification | Σ | 0..0 | BackboneElement | Element idConsent.verificationShort description n/a Definitionn/a n/a n/a
| ||
| provision | Σ | 0..0 | BackboneElement | Element idConsent.provisionShort description n/a Definitionn/a n/a n/a
|
Terminologies
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| Consent.language | preferred | http://hl7.org/fhir/ValueSet/languages | IETF language tag |
| Consent.status | required | http://hl7.org/fhir/ValueSet/consent-state-codes|4.3.0 | Indicates the state of the consent. |
| Consent.scope | extensible | http://hl7.org/fhir/ValueSet/consent-scope | The four anticipated uses for the Consent Resource. |
| Consent.scope.coding | required | http://ihis.sg/ValueSet/hsg-consent-scope | |
| Consent.category | extensible | http://hl7.org/fhir/ValueSet/consent-category | A classification of the type of consents found in a consent statement. |
| Consent.category.coding | required | http://ihis.sg/ValueSet/hsg-consent-category | |
| Consent.patient.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | |
| Consent.provision.type | required | http://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0 | How a rule statement is applied, such as adding additional consent or removing consent. |
| Consent.provision.actor.role | extensible | http://hl7.org/fhir/ValueSet/security-role-type | How an actor is involved in the consent considerations. |
| Consent.provision.action | example | http://hl7.org/fhir/ValueSet/consent-action | Detailed codes for the consent action. |
| Consent.provision.securityLabel | extensible | http://hl7.org/fhir/ValueSet/security-labels | Security Labels from the Healthcare Privacy and Security Classification System. |
| Consent.provision.purpose | extensible | http://terminology.hl7.org/ValueSet/v3-PurposeOfUse | What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
| Consent.provision.class | extensible | http://hl7.org/fhir/ValueSet/consent-content-class | The class (type) of information a consent rule covers. |
| Consent.provision.code | example | http://hl7.org/fhir/ValueSet/consent-content-code | If this code is found in an instance, then the exception applies. |
| Consent.provision.data.meaning | required | http://hl7.org/fhir/ValueSet/consent-data-meaning|4.3.0 | How a resource reference is interpreted when testing consent restrictions. |