2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: ConsentDirective

The official URL for this profile is: 

http://hl7.org/fhir/Profile/consentdirective-consentdirective

. Profile of Contract resource for use with Patient Privacy Consent Directive. : Consent Directive

This profile was published on Fri, Jan 31, 2014 00:00+1100 as a draft by Health Level Seven, Inc. - CBCC and Security WG.

Summary

Required/Prohibited Elements

  • The element Contract is required
  • The element Contract.subject is required
  • The element Contract.type is required
  • The element Contract.issued is required
  • The element Contract.quantity is prohibited
  • The element Contract.unitPrice is prohibited
  • The element Contract.factor is prohibited
  • The element Contract.points is prohibited
  • The element Contract.net is prohibited
  • The element Contract.grantor is required
  • The element Contract.grantee is required
  • The element Contract.signer.type is required
  • The element Contract.signer.signature is required
  • The element Contract.term.subject is required
  • The element Contract.term.issued is required
  • The element Contract.term.applies is required
  • The element Contract.term.quantity is prohibited
  • The element Contract.term.unitPrice is prohibited
  • The element Contract.term.factor is prohibited
  • The element Contract.term.points is prohibited
  • The element Contract.term.net is prohibited

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Differential View

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 1..1
... identifier 0..1IdentifierUnique Identifier of this Consent Directive.
... subject 1..*AnySubject of this Consent Directive (The Patient).
... authority 0..1OrganizationAuthority by which this Consent Directive is obtained.
... domain 0..*LocationOrganizational Domain for which this Consent Directive applies.
... type 1..1CodeableConceptType of Consent Directive (I presume this is going to be a fixed value?).
... subtype 0..*CodeableConceptSubtype of the Consent Directive.
... issued 1..1dateTimeWhen the Consent Directive was issued.
... applies 0..1PeriodEffective time of the Consent Directive.
... quantity 0..0
... unitPrice 0..0
... factor 0..0
... points 0..0
... net 0..0
... author 0..*Author of the Consent Directive.
... grantor 1..*Consenter, Deegator, or Substitute Decision Maker.
... grantee 1..*Consent Directive Grantee or Grantor Delegate (isn't a grantor delegate by definition the grantee?).
... witness 0..*Witness to the Consent Directive.
... executor 0..*Enforcing agent of the Consent Directive.
... notary 0..*Notary Public that witness the consent directive (How is this not just a type of witness?).
... signer 0..*Digital signature across the consent.
.... type 1..*CodingType of digital signature, duplicate of type of digital signature found within the signature block.
.... signature 1..1stringThe Digital-Signature block in base64 encoding of the XML-Signature format.
... term 0..*TermsThe terms of the consent directive.
.... identifier 0..1IdentifierThe identifier of this term of the consent directive.
.... type 0..1CodeableConceptThe consent directive term type.
.... subtype 0..1CodeableConceptThe consent directive term sub-type.
.... subject 1..1AnyThe consent directive term subject.
.... text 0..1stringThe consent directive term in a human readable text.
.... issued 1..1dateTimeThe consent directive term date issued.
.... applies 1..1PeriodThe effective date over which the consent directive term applies.
.... quantity 0..0Quantity
.... unitPrice 0..0Money
.... factor 0..0decimal
.... points 0..0decimal
.... net 0..0Money
... binding 0..1AttachmentThe legally binding text of the consent directive.
... bindingDateTime 0..1dateTimeThe date that the legally binding text was created.
... friendly 0..*AttachmentThe patient friendly text that represents the meaning of the consent directive.
... friendlyDateTime 0..1dateTimeThe date that the patient friendly text was created.
... legal 0..*AttachmentThe legal language of the consent directive.
... legalDateTime 0..1dateTimeThe date that the legal text was created.
... rule 0..*AttachmentComputer processable rules that represent the consent directive meaning.
... ruleDateTime 0..1dateTimeThe date that the computer processable rules were published.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 1..1A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierUnique Identifier of this Consent Directive.
... subject Σ1..*AnySubject of this Consent Directive (The Patient).
... authority 0..1OrganizationAuthority by which this Consent Directive is obtained.
... domain 0..*LocationOrganizational Domain for which this Consent Directive applies.
... type Σ1..1CodeableConceptType of Consent Directive (I presume this is going to be a fixed value?).
Binding: ContractType (example, extensible)
... subtype Σ0..*CodeableConceptSubtype of the Consent Directive.
Binding: ContractSubtype (example, extensible)
... issued Σ1..1dateTimeWhen the Consent Directive was issued.
... applies Σ0..1PeriodEffective time of the Consent Directive.
... author Σ0..*Practitioner, RelatedPerson, OrganizationAuthor of the Consent Directive.
... grantor Σ1..*Practitioner, RelatedPerson, Organization, PatientConsenter, Deegator, or Substitute Decision Maker.
... grantee Σ1..*Practitioner, RelatedPerson, Organization, PatientConsent Directive Grantee or Grantor Delegate (isn't a grantor delegate by definition the grantee?).
... witness 0..*Practitioner, RelatedPerson, PatientWitness to the Consent Directive.
... executor Σ0..*Practitioner, RelatedPerson, Organization, PatientEnforcing agent of the Consent Directive.
... notary Σ0..*Practitioner, RelatedPerson, Organization, PatientNotary Public that witness the consent directive (How is this not just a type of witness?).
... signer 0..*Digital signature across the consent.
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... type 1..*CodingType of digital signature, duplicate of type of digital signature found within the signature block.
Binding: ContractSignerType (example, extensible)
.... signature 1..1stringThe Digital-Signature block in base64 encoding of the XML-Signature format.
... term 0..*TermsThe terms of the consent directive.
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..1IdentifierThe identifier of this term of the consent directive.
.... type 0..1CodeableConceptThe consent directive term type.
Binding: ContractTermType (example, extensible)
.... subtype 0..1CodeableConceptThe consent directive term sub-type.
Binding: ContractTermSubType (example, extensible)
.... subject 1..1AnyThe consent directive term subject.
.... text 0..1stringThe consent directive term in a human readable text.
.... issued Σ1..1dateTimeThe consent directive term date issued.
.... applies Σ1..1PeriodThe effective date over which the consent directive term applies.
... binding 0..1AttachmentThe legally binding text of the consent directive.
... bindingDateTime 0..1dateTimeThe date that the legally binding text was created.
... friendly 0..*AttachmentThe patient friendly text that represents the meaning of the consent directive.
... friendlyDateTime 0..1dateTimeThe date that the patient friendly text was created.
... legal 0..*AttachmentThe legal language of the consent directive.
... legalDateTime 0..1dateTimeThe date that the legal text was created.
... rule 0..*AttachmentComputer processable rules that represent the consent directive meaning.
... ruleDateTime 0..1dateTimeThe date that the computer processable rules were published.

XML Template

JSON Template

todo

Differential View

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 1..1
... identifier 0..1IdentifierUnique Identifier of this Consent Directive.
... subject 1..*AnySubject of this Consent Directive (The Patient).
... authority 0..1OrganizationAuthority by which this Consent Directive is obtained.
... domain 0..*LocationOrganizational Domain for which this Consent Directive applies.
... type 1..1CodeableConceptType of Consent Directive (I presume this is going to be a fixed value?).
... subtype 0..*CodeableConceptSubtype of the Consent Directive.
... issued 1..1dateTimeWhen the Consent Directive was issued.
... applies 0..1PeriodEffective time of the Consent Directive.
... quantity 0..0
... unitPrice 0..0
... factor 0..0
... points 0..0
... net 0..0
... author 0..*Author of the Consent Directive.
... grantor 1..*Consenter, Deegator, or Substitute Decision Maker.
... grantee 1..*Consent Directive Grantee or Grantor Delegate (isn't a grantor delegate by definition the grantee?).
... witness 0..*Witness to the Consent Directive.
... executor 0..*Enforcing agent of the Consent Directive.
... notary 0..*Notary Public that witness the consent directive (How is this not just a type of witness?).
... signer 0..*Digital signature across the consent.
.... type 1..*CodingType of digital signature, duplicate of type of digital signature found within the signature block.
.... signature 1..1stringThe Digital-Signature block in base64 encoding of the XML-Signature format.
... term 0..*TermsThe terms of the consent directive.
.... identifier 0..1IdentifierThe identifier of this term of the consent directive.
.... type 0..1CodeableConceptThe consent directive term type.
.... subtype 0..1CodeableConceptThe consent directive term sub-type.
.... subject 1..1AnyThe consent directive term subject.
.... text 0..1stringThe consent directive term in a human readable text.
.... issued 1..1dateTimeThe consent directive term date issued.
.... applies 1..1PeriodThe effective date over which the consent directive term applies.
.... quantity 0..0Quantity
.... unitPrice 0..0Money
.... factor 0..0decimal
.... points 0..0decimal
.... net 0..0Money
... binding 0..1AttachmentThe legally binding text of the consent directive.
... bindingDateTime 0..1dateTimeThe date that the legally binding text was created.
... friendly 0..*AttachmentThe patient friendly text that represents the meaning of the consent directive.
... friendlyDateTime 0..1dateTimeThe date that the patient friendly text was created.
... legal 0..*AttachmentThe legal language of the consent directive.
... legalDateTime 0..1dateTimeThe date that the legal text was created.
... rule 0..*AttachmentComputer processable rules that represent the consent directive meaning.
... ruleDateTime 0..1dateTimeThe date that the computer processable rules were published.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 1..1A formal agreement between parties regarding the conduct of business, exchange of information or other matters.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierUnique Identifier of this Consent Directive.
... subject Σ1..*AnySubject of this Consent Directive (The Patient).
... authority 0..1OrganizationAuthority by which this Consent Directive is obtained.
... domain 0..*LocationOrganizational Domain for which this Consent Directive applies.
... type Σ1..1CodeableConceptType of Consent Directive (I presume this is going to be a fixed value?).
Binding: ContractType (example, extensible)
... subtype Σ0..*CodeableConceptSubtype of the Consent Directive.
Binding: ContractSubtype (example, extensible)
... issued Σ1..1dateTimeWhen the Consent Directive was issued.
... applies Σ0..1PeriodEffective time of the Consent Directive.
... author Σ0..*Practitioner, RelatedPerson, OrganizationAuthor of the Consent Directive.
... grantor Σ1..*Practitioner, RelatedPerson, Organization, PatientConsenter, Deegator, or Substitute Decision Maker.
... grantee Σ1..*Practitioner, RelatedPerson, Organization, PatientConsent Directive Grantee or Grantor Delegate (isn't a grantor delegate by definition the grantee?).
... witness 0..*Practitioner, RelatedPerson, PatientWitness to the Consent Directive.
... executor Σ0..*Practitioner, RelatedPerson, Organization, PatientEnforcing agent of the Consent Directive.
... notary Σ0..*Practitioner, RelatedPerson, Organization, PatientNotary Public that witness the consent directive (How is this not just a type of witness?).
... signer 0..*Digital signature across the consent.
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... type 1..*CodingType of digital signature, duplicate of type of digital signature found within the signature block.
Binding: ContractSignerType (example, extensible)
.... signature 1..1stringThe Digital-Signature block in base64 encoding of the XML-Signature format.
... term 0..*TermsThe terms of the consent directive.
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..1IdentifierThe identifier of this term of the consent directive.
.... type 0..1CodeableConceptThe consent directive term type.
Binding: ContractTermType (example, extensible)
.... subtype 0..1CodeableConceptThe consent directive term sub-type.
Binding: ContractTermSubType (example, extensible)
.... subject 1..1AnyThe consent directive term subject.
.... text 0..1stringThe consent directive term in a human readable text.
.... issued Σ1..1dateTimeThe consent directive term date issued.
.... applies Σ1..1PeriodThe effective date over which the consent directive term applies.
... binding 0..1AttachmentThe legally binding text of the consent directive.
... bindingDateTime 0..1dateTimeThe date that the legally binding text was created.
... friendly 0..*AttachmentThe patient friendly text that represents the meaning of the consent directive.
... friendlyDateTime 0..1dateTimeThe date that the patient friendly text was created.
... legal 0..*AttachmentThe legal language of the consent directive.
... legalDateTime 0..1dateTimeThe date that the legal text was created.
... rule 0..*AttachmentComputer processable rules that represent the consent directive meaning.
... ruleDateTime 0..1dateTimeThe date that the computer processable rules were published.

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Contract.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Contract.typeContractTypeexample (extensible)Contract Type Codes
Contract.subtypeContractSubtypeexample (extensible)Contract Subtype Codes
Contract.signer.typeContractSignerTypeexample (extensible)Contract Signer Type Codes
Contract.term.typeContractTermTypeexample (extensible)Contract Term Type Codes
Contract.term.subtypeContractTermSubTypeexample (extensible)Contract Term Type Codes

Constraints

IdPathNameDetails
.