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 Health Services Platform Consortion (HSPC) Attribution - Definitions

Todo

Definitions for the provenance-hspcattribution-hspcattribution Profile.

Provenance(HSPCAttribution)
Definition

Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.

Control1..1
Requirements
Alternate NamesHistory, Event, Activity
Comments

Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.

Provenance.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.

Provenance.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
Provenance.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.

Provenance.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).

Provenance.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.

Provenance.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.

Provenance.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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
Provenance.extension (http://hl7.org/fhir/Profile/provenance-hspc-attribution-attributionCode)
Definition

The type of attribution: Observed, verified, etc….

Control1..1
BindingCode representing the type of attribution
The codes SHOULD be taken from Attribution Code; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements
Comments
Provenance.extension (http://hl7.org/fhir/Profile/provenance-hspc-attribution-patientLocation)
Definition

PatientLocation indicates the place where the patient is currently located.

Control0..1
Typestring
Requirements
Comments
Provenance.extension (http://hl7.org/fhir/Profile/provenance-hspc-attribution-providerLocation)
Definition

ProviderLocation captures the information about where the provider is.

Control0..1
Typestring
Requirements
Comments
Provenance.extension (http://hl7.org/fhir/Profile/provenance-hspc-attribution-actionMethod)
Definition

ActionMethod is an abstract model for Method. This component captures what method used in Attribution models. For instance, in Verified, it captures how verification is achieved (verbal, written, telephone, etc.).

Control0..1
TypeCodeableConcept
Requirements
Comments
Provenance.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.

Provenance.target
Definition

The Reference(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.

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

Target references are usually version specific, but may not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.

Provenance.period
Definition

The period during which the activity occurred.

Control0..1
TypePeriod
Requirements
Comments

The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.

Provenance.recorded
Definition

The instant of time at which the activity was recorded.

Control1..1
Typeinstant
Requirements
Comments

This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.

Provenance.reason
Definition

The reason that the activity was taking place.

Control0..1
TypeCodeableConcept
Requirements
Comments
Provenance.location
Definition

Where the activity occurred, if relevant.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Location))
Requirements
Comments
Provenance.policy
Definition

Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.

Control0..*
Typeuri
Requirements
Comments
Provenance.agent
Definition

An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility.

Control0..*
Requirements
Comments

Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.

Provenance.agent.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Provenance.agent.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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
Provenance.agent.extension (http://hl7.org/fhir/Profile/provenance-hspc-attribution-individualPerson)
Definition

IndividualPerson is the identifying information that describes an individual: name, ID.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Person))
Requirements
Comments
Provenance.agent.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.

Provenance.agent.role
Definition

The role that the participant played.

Control1..1
BindingThe role that a provenance agent played
The codes SHOULD be taken from ProvenanceParticipantRole; other codes may be used where these codes are not suitable
TypeCoding
Requirements
Comments
Provenance.agent.type
Definition

The type of the participant.

Control1..1
BindingThe type of a provenance agent
The codes SHOULD be taken from ProvenanceParticipantType; other codes may be used where these codes are not suitable
TypeCoding
Requirements
Comments

If the type is "Resource" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.

Provenance.agent.reference
Definition

Identity of participant. May be a logical or physical uri and maybe absolute or relative.

Control1..1
Typeuri
Requirements
Comments

identity may be a reference to a resource or to something else, depending on the type.

Provenance.agent.display
Definition

Human-readable description of the participant.

Control0..1
Typestring
Requirements
Comments
Provenance.entity
Definition

An entity used in this activity.

Control0..*
Requirements
Comments
Provenance.entity.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Provenance.entity.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.

Provenance.entity.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.

Provenance.entity.role
Definition

How the entity was used during the activity.

Control1..1
BindingHow an entity was used in an activity
The codes SHALL be taken from ProvenanceEntityRole
Typecode
Requirements
Comments
Provenance.entity.type
Definition

The type of the entity. If the entity is a resource, then this is a resource type.

Control1..1
BindingThe type of an entity used in an activity
The codes SHOULD be taken from ResourceType; other codes may be used where these codes are not suitable
TypeCoding
Requirements
Comments

If the type is "resource" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.

Provenance.entity.reference
Definition

Identity of participant. May be a logical or physical uri and maybe absolute or relative.

Control1..1
Typeuri
Requirements
Comments

identity may be a reference to a resource or to something else, depending on the type.

Provenance.entity.display
Definition

Human-readable description of the entity.

Control0..1
Typestring
Requirements
Comments
Provenance.entity.agent
Definition

The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.

Control0..1
TypeSee agent
Requirements
Comments
Provenance.integritySignature
Definition

A digital signature on the target Reference(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.

Control0..1
Typestring
Requirements
Comments

Whether the content is XML or JSON, the representation is as a base64 of the XML signature of the resource.