abstractbaseDefinitioncopyrightdatedescriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurlversion| Left: | Specialty Rx Consent (http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent) |
| Right: | Specialty Rx Consent (http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent) |
| Error | Consent.patient | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient]]) |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/StructureDefinition/Consent | ||
| copyright | |||
| date | 2021-12-08T00:00:00-05:00 | ||
| description | This profile constrains a Consent resource to convey consents and authorizations associated with fulfillment of a specialty medication or other product | ||
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | SpecialtyRxConsent | ||
| publisher | HL7 International - Pharmacy | ||
| purpose | |||
| status | active | ||
| title | Specialty Rx Consent | ||
| type | Consent | ||
| url | http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent | ||
| version | 2.0.0-ballot | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Consent | I | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | I | 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 | string | Logical id of this artifact | Σ | 0..1 | string | Logical id of this artifact | |||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
| language | 0..1 | code | Language of the resource content Binding: todo (preferred): A human 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 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"} | Σ | 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: todo (required) | ?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: Specialty Rx Value Set - Consent Status (required) | |||||||||
| scope | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: todo (extensible): The four anticipated uses for the Consent Resource. | ?!Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. | |||||||||
| category | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: todo (extensible): A classification of the type of consents found in a consent statement. | Σ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | |||||||||
| patient | SΣ | 0..1 | Reference(http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient) | Related patient | SΣ | 0..1 | Reference(US Core Patient Profile) | Related patient |
| ||||||||
| dateTime | Σ | 0..1 | dateTime | When this Consent was created or indexed | Σ | 0..1 | dateTime | When this Consent was created or indexed | |||||||||
| performer | Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | Σ | 0..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |||||||||
| organization | Σ | 0..* | Reference(Organization) | Custodian of the consent | Σ | 0..* | Reference(Organization) | Custodian of the consent | |||||||||
| Slices for source[x] | Σ | 1..1 | Attachment | Source from which this consent is taken Slice: Unordered, Closed by type:$this | Σ | 1..1 | Attachment | Source from which this consent is taken Slice: Unordered, Closed by type:$this | |||||||||
 policy | 0..* | BackboneElement | Policies covered by this consent | 0..* | BackboneElement | Policies covered by this consent | |||||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| authority | I | 0..1 | uri | Enforcement source for policy | I | 0..1 | uri | Enforcement source for policy | |||||||||
| uri | I | 0..1 | uri | Specific policy covered by this consent | I | 0..1 | uri | Specific policy covered by this consent | |||||||||
| policyRule | SΣI | 0..1 | CodeableConcept | Regulation that this consents to Binding: todo (extensible): Regulatory policy examples. Fixed Value: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"OPTIN","display":"opt-in"}]} | SΣI | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. Fixed Value: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"OPTIN","display":"opt-in"}]} | |||||||||
| verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | Σ | 0..* | BackboneElement | Consent Verified by patient or family | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| verified | Σ | 1..1 | boolean | Has been verified | Σ | 1..1 | boolean | Has been verified | |||||||||
| verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||||||||
| verificationDate | 0..1 | dateTime | When consent verified | 0..1 | dateTime | When consent verified | |||||||||||
 provision | Σ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule | Σ | 0..1 | BackboneElement | Constraints to the base Consent.policyRule | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| type | Σ | 0..1 | code | deny | permit Binding: todo (required): How a rule statement is applied, such as adding additional consent or removing consent. | Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | |||||||||
| period | Σ | 0..1 | Period | Timeframe for this rule | Σ | 0..1 | Period | Timeframe for this rule | |||||||||
| actor | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| role | 1..1 | CodeableConcept | How the actor is involved Binding: todo (extensible): How an actor is involved in the consent considerations. | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||||||||
| reference | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||||||||
| action | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: todo (example): Detailed codes for the consent action. | Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | |||||||||
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: todo (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | Coding | Security Labels that define affected resources 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: todo (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | Σ | 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 | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: todo (extensible): The class (type) of information a consent rule covers. | Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | |||||||||
| code | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: todo (example): If this code is found in an instance, then the exception applies. | Σ | 0..* | CodeableConcept | e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies. | |||||||||
| dataPeriod | Σ | 0..1 | Period | Timeframe for data controlled by this rule | Σ | 0..1 | Period | Timeframe for data controlled by this rule | |||||||||
| data | Σ | 0..* | BackboneElement | Data controlled by this rule | Σ | 0..* | BackboneElement | Data controlled by this rule | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: todo (required): How a resource reference is interpreted when testing consent restrictions. | Σ | 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 | Σ | 1..1 | Reference(Resource) | The actual data reference | |||||||||
 provision | 0..* | See provision (Consent) | Nested Exception Rules | 0..* | See provision (Consent) | Nested Exception Rules | |||||||||||
| Documentation for this format | |||||||||||||||||