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 Consent Directive - Definitions

Todo

Definitions for the consentdirective-consentdirective Profile.

Contract(ConsentDirective)
Definition

A formal agreement between parties regarding the conduct of business, exchange of information or other matters.

Control1..1
Requirements
Comments
Contract.id
Definition

The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.

Control0..1
Typeid
Requirements
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Contract.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Requirements
Comments
Contract.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Requirements
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Contract.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource

Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Contract.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Contract.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Requirements
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Contract.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contract.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contract.identifier
Definition

Unique Identifier of this Consent Directive.

Control0..1
TypeIdentifier
Requirements
Comments
Contract.subject
Definition

Subject of this Consent Directive (The Patient).

Control1..*
TypeReference(Profile = http://hl7.org/fhir/Profile/Any)
Requirements
Comments
Contract.authority
Definition

Authority by which this Consent Directive is obtained.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements
Comments
Contract.domain
Definition

Organizational Domain for which this Consent Directive applies.

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Location))
Requirements
Comments
Contract.type
Definition

Type of Consent Directive (I presume this is going to be a fixed value?).

Control1..1
BindingList of overall contract codes
For example codes, see Contract Type Codes
TypeCodeableConcept
Requirements
Comments
Contract.subtype
Definition

Subtype of the Consent Directive.

Control0..*
BindingDetailed codes within the above
For example codes, see Contract Subtype Codes
TypeCodeableConcept
Requirements
Comments
Contract.issued
Definition

When the Consent Directive was issued.

Control1..1
TypedateTime
Requirements
Comments
Contract.applies
Definition

Effective time of the Consent Directive.

Control0..1
TypePeriod
Requirements
Comments
Contract.quantity
Definition

The number of repetitions of a service or product.

Control0..0
TypeQuantity
Requirements
Comments
Contract.unitPrice
Definition

The unit price product.

Control0..0
TypeMoney
Requirements
Comments
Contract.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..0
Typedecimal
Requirements
Comments
Contract.points
Definition

An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

Control0..0
Typedecimal
Requirements
Comments
Contract.net
Definition

The quantity times the unit price for an additional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control0..0
TypeMoney
Requirements
Comments
Contract.author
Definition

Author of the Consent Directive.

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization))
Requirements
Comments
Contract.grantor
Definition

Consenter, Deegator, or Substitute Decision Maker.

Control1..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
Contract.grantee
Definition

Consent Directive Grantee or Grantor Delegate (isn't a grantor delegate by definition the grantee?).

Control1..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
Contract.witness
Definition

Witness to the Consent Directive.

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
Contract.executor
Definition

Enforcing agent of the Consent Directive.

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
Contract.notary
Definition

Notary Public that witness the consent directive (How is this not just a type of witness?).

Control0..*
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/RelatedPerson)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
Contract.signer
Definition

Digital signature across the consent.

Control0..*
Requirements
Comments
Contract.signer.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Contract.signer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contract.signer.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contract.signer.type
Definition

Type of digital signature, duplicate of type of digital signature found within the signature block.

Control1..*
BindingAn indication of the reason that an entity signed a document
For example codes, see Contract Signer Type Codes
TypeCoding
Requirements
Comments
Contract.signer.signature
Definition

The Digital-Signature block in base64 encoding of the XML-Signature format.

Control1..1
Typestring
Requirements
Comments
Contract.term
Definition

The terms of the consent directive.

Control0..*
TypeTerms
Requirements
Comments
Contract.term.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Contract.term.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contract.term.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Contract.term.identifier
Definition

The identifier of this term of the consent directive.

Control0..1
TypeIdentifier
Requirements
Comments
Contract.term.type
Definition

The consent directive term type.

Control0..1
BindingDetailed codes for the types of contract provisions
For example codes, see Contract Term Type Codes
TypeCodeableConcept
Requirements
Comments
Contract.term.subtype
Definition

The consent directive term sub-type.

Control0..1
BindingDetailed codes for the subtypes of contract provisions
For example codes, see Contract Term Type Codes
TypeCodeableConcept
Requirements
Comments
Contract.term.subject
Definition

The consent directive term subject.

Control1..1
TypeReference(Profile = http://hl7.org/fhir/Profile/Any)
Requirements
Comments
Contract.term.text
Definition

The consent directive term in a human readable text.

Control0..1
Typestring
Requirements
Comments
Contract.term.issued
Definition

The consent directive term date issued.

Control1..1
TypedateTime
Requirements
Comments
Contract.term.applies
Definition

The effective date over which the consent directive term applies.

Control1..1
TypePeriod
Requirements
Comments
Contract.term.quantity
Definition

The number of repetitions of a service or product.

Control0..0
TypeQuantity
Requirements
Comments
Contract.term.unitPrice
Definition

The unit price product.

Control0..0
TypeMoney
Requirements
Comments
Contract.term.factor
Definition

A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.

Control0..0
Typedecimal
Requirements
Comments
Contract.term.points
Definition

An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.

Control0..0
Typedecimal
Requirements
Comments
Contract.term.net
Definition

The quantity times the unit price for an additional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.

Control0..0
TypeMoney
Requirements
Comments
Contract.binding
Definition

The legally binding text of the consent directive.

Control0..1
TypeAttachment
Requirements
Comments
Contract.bindingDateTime
Definition

The date that the legally binding text was created.

Control0..1
TypedateTime
Requirements
Comments
Contract.friendly
Definition

The patient friendly text that represents the meaning of the consent directive.

Control0..*
TypeAttachment
Requirements
Comments
Contract.friendlyDateTime
Definition

The date that the patient friendly text was created.

Control0..1
TypedateTime
Requirements
Comments
Contract.legal
Definition

The legal language of the consent directive.

Control0..*
TypeAttachment
Requirements
Comments
Contract.legalDateTime
Definition

The date that the legal text was created.

Control0..1
TypedateTime
Requirements
Comments
Contract.rule
Definition

Computer processable rules that represent the consent directive meaning.

Control0..*
TypeAttachment
Requirements
Comments
Contract.ruleDateTime
Definition

The date that the computer processable rules were published.

Control0..1
TypedateTime
Requirements
Comments