This page is part of the 同意書實作指引 (v0.1.0: Releases Ballot 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hitstdio.ntunhs.edu.tw/consentForm/StructureDefinition/Consent-cf | Version: 0.1.0 | |||
Active as of 2023-05-16 | Computable Name: ConsentBase |
此同意書(Consent-Base) Profile說明本IG如何進一步定義FHIR的Consent Resource以呈現同意書資料
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Required Pattern: active |
scope | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
Slices for category | S | 1..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Slice: Unordered, Open by pattern:$this |
category:tw-consent-category | S | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: 同意書類別值集 (required) |
category:loinc-consent-category | S | 0..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (required) |
patient | S | 1..1 | Reference(TW Core Patient) | Who the consent applies to |
dateTime | S | 0..1 | dateTime | When this Consent was created or indexed |
performer | S | 0..* | Reference(TW Core Organization Government) | Who is agreeing to the policy and rules |
organization | 0..* | Reference(TW Core Organization Hospital Department) | Custodian of the consent | |
source[x] | S | 1..1 | Reference(DocumentReference-CF) | Source from which this consent is taken |
policyRule | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: 同意書政策依據值集 (required) |
verification | S | 0..* | BackboneElement | Consent Verified by patient or family |
verified | S | 1..1 | boolean | Has been verified |
verifiedWith | S | 0..1 | Reference(TW Core Patient | RelatedPerson) | Person who verified |
verificationDate | S | 0..1 | dateTime | When consent verified |
provision | S | 0..1 | BackboneElement | Constraints to the base Consent.policyRule |
type | S | 0..1 | code | deny | permit Required Pattern: permit |
actor | S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
role | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
action | S | 0..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
securityLabel | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 |
class | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 |
code | S | 0..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
coding | 0..1 | CodingTW | 由專門術語系統(terminology system)定義的代碼 | |
system | 0..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://loinc.org | |
code | 0..1 | code | 系統定義的語法之符號 Required Pattern: 59284-0 | |
Documentation for this format |
Path | Conformance | ValueSet |
Consent.category:tw-consent-category | required | ConsentCategory (a valid code from 同意書類別) |
Consent.category:loinc-consent-category | required | ConsentCategoryCodes |
Consent.policyRule | required | PolicyRule |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active |
scope | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. |
Slices for category | SΣ | 1..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
category:tw-consent-category | SΣ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: 同意書類別值集 (required) |
category:loinc-consent-category | SΣ | 0..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (required) |
patient | SΣ | 1..1 | Reference(TW Core Patient) | Who the consent applies to |
dateTime | SΣ | 0..1 | dateTime | When this Consent was created or indexed |
performer | SΣ | 0..* | Reference(TW Core Organization Government) | Who is agreeing to the policy and rules |
organization | Σ | 0..* | Reference(TW Core Organization Hospital Department) | Custodian of the consent |
source[x] | SΣ | 1..1 | Reference(DocumentReference-CF) | Source from which this consent is taken |
policyRule | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: 同意書政策依據值集 (required) |
verification | SΣ | 0..* | BackboneElement | Consent Verified by patient or family |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
verified | SΣ | 1..1 | boolean | Has been verified |
verifiedWith | S | 0..1 | Reference(TW Core Patient | RelatedPerson) | Person who verified |
verificationDate | S | 0..1 | dateTime | When consent verified |
provision | SΣ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit |
actor | S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. |
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
action | S | 0..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentActionCodes (example): Detailed codes for the consent action. |
securityLabel | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
class | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. |
code | S | 0..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. |
coding | S | 0..1 | CodingTW | 由專門術語系統(terminology system)定義的代碼 |
system | SΣ | 0..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://loinc.org |
code | SΣ | 0..1 | code | 系統定義的語法之符號 Required Pattern: 59284-0 |
display | SΣ | 0..1 | string | 由系統定義的表示法 |
text | SΣ | 0..1 | string | 概念的文字表示法 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Consent.status | required | Pattern: active |
Consent.scope | extensible | ConsentScopeCodes |
Consent.category | extensible | ConsentCategoryCodes |
Consent.category:tw-consent-category | required | ConsentCategory (a valid code from 同意書類別) |
Consent.category:loinc-consent-category | required | ConsentCategoryCodes |
Consent.policyRule | required | PolicyRule |
Consent.provision.type | required | Pattern: permit |
Consent.provision.actor.role | extensible | SecurityRoleType |
Consent.provision.action | example | ConsentActionCodes |
Consent.provision.securityLabel | extensible | All Security Labels |
Consent.provision.class | extensible | ConsentContentClass |
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} | ||||
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active | ||||
scope | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | ||||
Slices for category | SΣ | 1..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
category:tw-consent-category | SΣ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: 同意書類別值集 (required) | ||||
category:loinc-consent-category | SΣ | 0..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (required) | ||||
patient | SΣ | 1..1 | Reference(TW Core Patient) | Who the consent applies to | ||||
dateTime | SΣ | 0..1 | dateTime | When this Consent was created or indexed | ||||
performer | SΣ | 0..* | Reference(TW Core Organization Government) | Who is agreeing to the policy and rules | ||||
organization | Σ | 0..* | Reference(TW Core Organization Hospital Department) | Custodian of the consent | ||||
source[x] | SΣ | 1..1 | Reference(DocumentReference-CF) | Source from which this consent is taken | ||||
policy | 0..* | BackboneElement | Policies covered by this consent | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | C | 0..1 | uri | Enforcement source for policy | ||||
uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
policyRule | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: 同意書政策依據值集 (required) | ||||
verification | SΣ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
verified | SΣ | 1..1 | boolean | Has been verified | ||||
verifiedWith | S | 0..1 | Reference(TW Core Patient | RelatedPerson) | Person who verified | ||||
verificationDate | S | 0..1 | dateTime | When consent verified | ||||
provision | SΣ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | ||||
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||||
action | S | 0..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
securityLabel | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
class | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
code | S | 0..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 Slice: Unordered, Open by value:url | |||||
coding | S | 0..1 | CodingTW | 由專門術語系統(terminology system)定義的代碼 | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 Slice: Unordered, Open by value:url | |||||
system | SΣ | 0..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://loinc.org | ||||
version | Σ | 0..1 | string | 系統的版本—如果相關的話 | ||||
code | SΣ | 0..1 | code | 系統定義的語法之符號 Required Pattern: 59284-0 | ||||
display | SΣ | 0..1 | string | 由系統定義的表示法 | ||||
userSelected | Σ | 0..1 | boolean | 此編碼是否由使用者直接選擇? | ||||
text | SΣ | 0..1 | string | 概念的文字表示法 | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
data | Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Consent.language | preferred | CommonLanguages
| ||||
Consent.status | required | Pattern: active | ||||
Consent.scope | extensible | ConsentScopeCodes | ||||
Consent.category | extensible | ConsentCategoryCodes | ||||
Consent.category:tw-consent-category | required | ConsentCategory (a valid code from 同意書類別) | ||||
Consent.category:loinc-consent-category | required | ConsentCategoryCodes | ||||
Consent.policyRule | required | PolicyRule | ||||
Consent.provision.type | required | Pattern: permit | ||||
Consent.provision.actor.role | extensible | SecurityRoleType | ||||
Consent.provision.action | example | ConsentActionCodes | ||||
Consent.provision.securityLabel | extensible | All Security Labels | ||||
Consent.provision.purpose | extensible | PurposeOfUse | ||||
Consent.provision.class | extensible | ConsentContentClass | ||||
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) | ||||
Consent.provision.data.meaning | required | ConsentDataMeaning |
This structure is derived from Consent
Summary
Mandatory: 4 elements
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
status | S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Required Pattern: active |
scope | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
Slices for category | S | 1..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Slice: Unordered, Open by pattern:$this |
category:tw-consent-category | S | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: 同意書類別值集 (required) |
category:loinc-consent-category | S | 0..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (required) |
patient | S | 1..1 | Reference(TW Core Patient) | Who the consent applies to |
dateTime | S | 0..1 | dateTime | When this Consent was created or indexed |
performer | S | 0..* | Reference(TW Core Organization Government) | Who is agreeing to the policy and rules |
organization | 0..* | Reference(TW Core Organization Hospital Department) | Custodian of the consent | |
source[x] | S | 1..1 | Reference(DocumentReference-CF) | Source from which this consent is taken |
policyRule | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: 同意書政策依據值集 (required) |
verification | S | 0..* | BackboneElement | Consent Verified by patient or family |
verified | S | 1..1 | boolean | Has been verified |
verifiedWith | S | 0..1 | Reference(TW Core Patient | RelatedPerson) | Person who verified |
verificationDate | S | 0..1 | dateTime | When consent verified |
provision | S | 0..1 | BackboneElement | Constraints to the base Consent.policyRule |
type | S | 0..1 | code | deny | permit Required Pattern: permit |
actor | S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
role | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
action | S | 0..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
securityLabel | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 |
class | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 |
code | S | 0..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 |
coding | 0..1 | CodingTW | 由專門術語系統(terminology system)定義的代碼 | |
system | 0..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://loinc.org | |
code | 0..1 | code | 系統定義的語法之符號 Required Pattern: 59284-0 | |
Documentation for this format |
Path | Conformance | ValueSet |
Consent.category:tw-consent-category | required | ConsentCategory (a valid code from 同意書類別) |
Consent.category:loinc-consent-category | required | ConsentCategoryCodes |
Consent.policyRule | required | PolicyRule |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active |
scope | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. |
Slices for category | SΣ | 1..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
category:tw-consent-category | SΣ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: 同意書類別值集 (required) |
category:loinc-consent-category | SΣ | 0..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (required) |
patient | SΣ | 1..1 | Reference(TW Core Patient) | Who the consent applies to |
dateTime | SΣ | 0..1 | dateTime | When this Consent was created or indexed |
performer | SΣ | 0..* | Reference(TW Core Organization Government) | Who is agreeing to the policy and rules |
organization | Σ | 0..* | Reference(TW Core Organization Hospital Department) | Custodian of the consent |
source[x] | SΣ | 1..1 | Reference(DocumentReference-CF) | Source from which this consent is taken |
policyRule | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: 同意書政策依據值集 (required) |
verification | SΣ | 0..* | BackboneElement | Consent Verified by patient or family |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
verified | SΣ | 1..1 | boolean | Has been verified |
verifiedWith | S | 0..1 | Reference(TW Core Patient | RelatedPerson) | Person who verified |
verificationDate | S | 0..1 | dateTime | When consent verified |
provision | SΣ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit |
actor | S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. |
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
action | S | 0..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentActionCodes (example): Detailed codes for the consent action. |
securityLabel | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
class | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. |
code | S | 0..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. |
coding | S | 0..1 | CodingTW | 由專門術語系統(terminology system)定義的代碼 |
system | SΣ | 0..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://loinc.org |
code | SΣ | 0..1 | code | 系統定義的語法之符號 Required Pattern: 59284-0 |
display | SΣ | 0..1 | string | 由系統定義的表示法 |
text | SΣ | 0..1 | string | 概念的文字表示法 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Consent.status | required | Pattern: active |
Consent.scope | extensible | ConsentScopeCodes |
Consent.category | extensible | ConsentCategoryCodes |
Consent.category:tw-consent-category | required | ConsentCategory (a valid code from 同意書類別) |
Consent.category:loinc-consent-category | required | ConsentCategoryCodes |
Consent.policyRule | required | PolicyRule |
Consent.provision.type | required | Pattern: permit |
Consent.provision.actor.role | extensible | SecurityRoleType |
Consent.provision.action | example | ConsentActionCodes |
Consent.provision.securityLabel | extensible | All Security Labels |
Consent.provision.class | extensible | ConsentContentClass |
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"} | ||||
status | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active | ||||
scope | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | ||||
Slices for category | SΣ | 1..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Slice: Unordered, Open by pattern:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
category:tw-consent-category | SΣ | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: 同意書類別值集 (required) | ||||
category:loinc-consent-category | SΣ | 0..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (required) | ||||
patient | SΣ | 1..1 | Reference(TW Core Patient) | Who the consent applies to | ||||
dateTime | SΣ | 0..1 | dateTime | When this Consent was created or indexed | ||||
performer | SΣ | 0..* | Reference(TW Core Organization Government) | Who is agreeing to the policy and rules | ||||
organization | Σ | 0..* | Reference(TW Core Organization Hospital Department) | Custodian of the consent | ||||
source[x] | SΣ | 1..1 | Reference(DocumentReference-CF) | Source from which this consent is taken | ||||
policy | 0..* | BackboneElement | Policies covered by this consent | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | C | 0..1 | uri | Enforcement source for policy | ||||
uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
policyRule | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: 同意書政策依據值集 (required) | ||||
verification | SΣ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
verified | SΣ | 1..1 | boolean | Has been verified | ||||
verifiedWith | S | 0..1 | Reference(TW Core Patient | RelatedPerson) | Person who verified | ||||
verificationDate | S | 0..1 | dateTime | When consent verified | ||||
provision | SΣ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | S | 1..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | ||||
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||||
action | S | 0..1 | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
securityLabel | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
class | S | 0..* | CodingTW | 由專門術語系統(terminology system)定義的代碼 Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
code | S | 0..* | CodeableConceptTW | 概念(Concept)— 參照一個專門術語或只是文字表述 Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 Slice: Unordered, Open by value:url | |||||
coding | S | 0..1 | CodingTW | 由專門術語系統(terminology system)定義的代碼 | ||||
id | 0..1 | string | 唯一可識別ID,以供資料項目間相互參照。 | |||||
extension | 0..* | Extension | 擴充的資料項目 Slice: Unordered, Open by value:url | |||||
system | SΣ | 0..1 | uri | 專門術語系統(terminology system)的識別 Required Pattern: http://loinc.org | ||||
version | Σ | 0..1 | string | 系統的版本—如果相關的話 | ||||
code | SΣ | 0..1 | code | 系統定義的語法之符號 Required Pattern: 59284-0 | ||||
display | SΣ | 0..1 | string | 由系統定義的表示法 | ||||
userSelected | Σ | 0..1 | boolean | 此編碼是否由使用者直接選擇? | ||||
text | SΣ | 0..1 | string | 概念的文字表示法 | ||||
dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
data | Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
provision | 0..* | See provision (Consent) | Nested Exception Rules | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Consent.language | preferred | CommonLanguages
| ||||
Consent.status | required | Pattern: active | ||||
Consent.scope | extensible | ConsentScopeCodes | ||||
Consent.category | extensible | ConsentCategoryCodes | ||||
Consent.category:tw-consent-category | required | ConsentCategory (a valid code from 同意書類別) | ||||
Consent.category:loinc-consent-category | required | ConsentCategoryCodes | ||||
Consent.policyRule | required | PolicyRule | ||||
Consent.provision.type | required | Pattern: permit | ||||
Consent.provision.actor.role | extensible | SecurityRoleType | ||||
Consent.provision.action | example | ConsentActionCodes | ||||
Consent.provision.securityLabel | extensible | All Security Labels | ||||
Consent.provision.purpose | extensible | PurposeOfUse | ||||
Consent.provision.class | extensible | ConsentContentClass | ||||
Consent.provision.code | example | ConsentContentCodes (a valid code from LOINC) | ||||
Consent.provision.data.meaning | required | ConsentDataMeaning |
This structure is derived from Consent
Summary
Mandatory: 4 elements
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。
必須(SHALL) 支援透過查詢參數 _id
查詢所有Consent:
(如何透過token查詢)
GET [base]/Consent?_id=[id]
GET [base]/Consent/[id]
例子:
(1) GET [base]/Consent?_id=con-example
(2) GET [base]/Consent/con-example
必須(SHALL) 支援透過查詢參數 category
查詢所有Consent:
(如何透過reference查詢)
GET [base]/Consent?category={system|}[code]
例子:
(1) GET [base]/Consent?category=http://hitstdio.ntunhs.edu.tw/consentForm/CodeSystem/consent-category|AFFT
(2) GET [base]/Consent?category=AFFT