Onyx Consent Authorization SAFHIR Implementation and Operations Guide
0.0.2 - ci-build
Onyx Consent Authorization SAFHIR Implementation and Operations Guide - Local Development build (v0.0.2). See the Directory of published versions
| Defining URL: | http://ig.fhir.safhir.io/ig/safhir-ocasio/StructureDefinition/ConsentSignature |
| Version: | 0.0.2 |
| Name: | ConsentSignature |
| Title: | Member Exchange Consent Signature |
| Status: | Draft as of 2021-11-29T21:14:01+00:00 |
| Definition: | The MemberExchangeConsent profile expresses a member's desire to have their health data transfered from a prior health plan to their current health plan. If a digital signature is to be provided as an optional element for the Consent record it is supplied as a signature in a Provenance record that refers to the consent resource. |
| Publisher: | Onyx Technology, LLC |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://ig.fhir.safhir.io/ig/safhir-ocasio/StructureDefinition/ConsentSignature
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreProvenance
Summary
Mandatory: 3 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
This structure is derived from USCoreProvenance
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | USCoreProvenance | US Core Provenance | |
![]() ![]() | 1..* | Reference(Consent for Member Data Exchange) | Reference the Consent resource that is being digitally signed | |
![]() ![]() | 1..1 | instant | Date/Time Consent was given by member to retrieve their clinical data from another payer. | |
![]() ![]() | 1..* | BackboneElement | Actor involved | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Attester to the validity of the consent request | |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: attester | |
![]() ![]() ![]() | 1..1 | Reference(US Core Organization Profile) | Provide US Core Organization record for the Payer recording the Consent for the member | |
![]() ![]() | 0..* | BackboneElement | Actor involved | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() | 0..1 | BackboneElement | Actor involved | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() | S | 1..* | Signature | Signature on target |
![]() ![]() ![]() | S | 1..* | Coding | Indication of the reason the entity signed the object(s) |
![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 1.2.840.10065.1.12.1.7 | |
![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system Required Pattern: Consent Signature | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Patient Profile) | Link to patient providing consent for record exchange |
![]() ![]() ![]() | S | 1..1 | base64Binary | The digital signature content as base64 encoded content. |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | USCoreProvenance | US Core Provenance | |
![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | SΣ | 1..* | Reference(Consent for Member Data Exchange) | Reference the Consent resource that is being digitally signed |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() | Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() | 0..1 | When the activity occurred | ||
![]() ![]() ![]() | Period | |||
![]() ![]() ![]() | dateTime | |||
![]() ![]() | SΣ | 1..1 | instant | Date/Time Consent was given by member to retrieve their clinical data from another payer. |
![]() ![]() | 0..* | uri | Policy or plan the activity was defined by | |
![]() ![]() | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |
![]() ![]() | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |
![]() ![]() | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |
![]() ![]() | S | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Attester to the validity of the consent request Binding: US Core Provenance Participant Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: attester |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Organization Profile) | Provide US Core Organization record for the Payer recording the Consent for the member |
![]() ![]() ![]() ![]() | SI | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
![]() ![]() ![]() | S | 0..* | BackboneElement | Actor involved |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: author | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() ![]() | S | 0..1 | BackboneElement | Actor involved |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: transmitter | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() | 0..* | BackboneElement | An entity used in this activity | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
![]() ![]() ![]() | Σ | 1..1 | Reference(Resource) | Identity of entity |
![]() ![]() ![]() | 0..* | See agent (Provenance) | Entity is attributed to this agent | |
![]() ![]() | S | 1..* | Signature | Signature on target |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 1.2.840.10065.1.12.1.7 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system Required Pattern: Consent Signature |
![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() | Σ | 1..1 | instant | When the signature was created |
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | Link to patient providing consent for record exchange |
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented |
![]() ![]() ![]() | 0..1 | code | The technical format of the signed resources Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
![]() ![]() ![]() | 0..1 | code | The technical format of the signature Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
![]() ![]() ![]() | S | 1..1 | base64Binary | The digital signature content as base64 encoded content. |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | USCoreProvenance | US Core Provenance | |
![]() ![]() | Σ | 1..* | Reference(Consent for Member Data Exchange) | Reference the Consent resource that is being digitally signed |
![]() ![]() ![]() | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() | Σ | 1..1 | instant | Date/Time Consent was given by member to retrieve their clinical data from another payer. |
![]() ![]() | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type | |
![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Attester to the validity of the consent request Binding: US Core Provenance Participant Type Codes (extensible) |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(US Core Organization Profile) | Provide US Core Organization record for the Payer recording the Consent for the member |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
![]() ![]() ![]() | 0..* | BackboneElement | Actor involved | |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: author | |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() ![]() | 0..1 | BackboneElement | Actor involved | |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: transmitter | |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() | 1..* | Signature | Signature on target | |
![]() ![]() ![]() | Σ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
![]() ![]() ![]() | Σ | 1..1 | Reference(US Core Patient Profile) | Link to patient providing consent for record exchange |
![]() ![]() ![]() | 1..1 | base64Binary | The digital signature content as base64 encoded content. | |
Documentation for this format | ||||
This structure is derived from USCoreProvenance
Summary
Mandatory: 3 elements
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from USCoreProvenance
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | USCoreProvenance | US Core Provenance | |
![]() ![]() | 1..* | Reference(Consent for Member Data Exchange) | Reference the Consent resource that is being digitally signed | |
![]() ![]() | 1..1 | instant | Date/Time Consent was given by member to retrieve their clinical data from another payer. | |
![]() ![]() | 1..* | BackboneElement | Actor involved | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Attester to the validity of the consent request | |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: attester | |
![]() ![]() ![]() | 1..1 | Reference(US Core Organization Profile) | Provide US Core Organization record for the Payer recording the Consent for the member | |
![]() ![]() | 0..* | BackboneElement | Actor involved | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() | 0..1 | BackboneElement | Actor involved | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() | S | 1..* | Signature | Signature on target |
![]() ![]() ![]() | S | 1..* | Coding | Indication of the reason the entity signed the object(s) |
![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 1.2.840.10065.1.12.1.7 | |
![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system Required Pattern: Consent Signature | |
![]() ![]() ![]() | S | 1..1 | Reference(US Core Patient Profile) | Link to patient providing consent for record exchange |
![]() ![]() ![]() | S | 1..1 | base64Binary | The digital signature content as base64 encoded content. |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | USCoreProvenance | US Core Provenance | |
![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | SΣ | 1..* | Reference(Consent for Member Data Exchange) | Reference the Consent resource that is being digitally signed |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | SΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() | Σ | 0..1 | string | Text alternative for the resource |
![]() ![]() | 0..1 | When the activity occurred | ||
![]() ![]() ![]() | Period | |||
![]() ![]() ![]() | dateTime | |||
![]() ![]() | SΣ | 1..1 | instant | Date/Time Consent was given by member to retrieve their clinical data from another payer. |
![]() ![]() | 0..* | uri | Policy or plan the activity was defined by | |
![]() ![]() | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |
![]() ![]() | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |
![]() ![]() | 0..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (extensible): The activity that took place. | |
![]() ![]() | S | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Attester to the validity of the consent request Binding: US Core Provenance Participant Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: attester |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Organization Profile) | Provide US Core Organization record for the Payer recording the Consent for the member |
![]() ![]() ![]() ![]() | SI | 0..1 | Reference(US Core Organization Profile) | Who the agent is representing provenance-1: onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device |
![]() ![]() ![]() | S | 0..* | BackboneElement | Actor involved |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: author | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() ![]() | S | 0..1 | BackboneElement | Actor involved |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: transmitter | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
![]() ![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Organization Profile) | Who participated |
![]() ![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |
![]() ![]() | 0..* | BackboneElement | An entity used in this activity | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
![]() ![]() ![]() | Σ | 1..1 | Reference(Resource) | Identity of entity |
![]() ![]() ![]() | 0..* | See agent (Provenance) | Entity is attributed to this agent | |
![]() ![]() | S | 1..* | Signature | Signature on target |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | SΣ | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object. |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 1.2.840.10065.1.12.1.7 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system Required Pattern: Consent Signature |
![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() | Σ | 1..1 | instant | When the signature was created |
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile) | Link to patient providing consent for record exchange |
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | The party represented |
![]() ![]() ![]() | 0..1 | code | The technical format of the signed resources Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
![]() ![]() ![]() | 0..1 | code | The technical format of the signature Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |
![]() ![]() ![]() | S | 1..1 | base64Binary | The digital signature content as base64 encoded content. |
Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Provenance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Provenance.target.type | extensible | ResourceType |
| Provenance.reason | extensible | PurposeOfUse |
| Provenance.activity | extensible | ProvenanceActivityType |
| Provenance.agent.type | extensible | USCoreProvenancePaticipantTypeCodes |
| Provenance.agent.role | example | SecurityRoleType |
| Provenance.agent:ProvenanceAuthor.type | extensible | Pattern: author |
| Provenance.agent:ProvenanceAuthor.role | example | SecurityRoleType |
| Provenance.agent:ProvenanceTransmitter.type | extensible | Pattern: transmitter |
| Provenance.agent:ProvenanceTransmitter.role | example | SecurityRoleType |
| Provenance.entity.role | required | ProvenanceEntityRole |
| Provenance.signature.type | preferred | SignatureTypeCodes |
| Provenance.signature.targetFormat | required | Mime Types |
| Provenance.signature.sigFormat | required | Mime Types |
| Id | Path | Details | Requirements |
| provenance-1 | Provenance.agent.onBehalfOf | onBehalfOf SHALL be present when Provenance.agent.who is a Practitioner or Device : ((%resource.agent.who.resolve() is Practitioner) or (%resource.agent.who.resolve() is Device)) implies exists() |