POCP Prescription Enrollment
0.1.0 - CI Build US

POCP Prescription Enrollment - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Rx Enroll Provenance Signature

Official URL: http://pocp.dev/fhir/us/rx-enroll/StructureDefinition/rx-enroll-provenance-signature Version: 0.1.0
Active as of 2022-02-27 Computable Name: RxEnrollProvenanceSignature

This profile constrains a Provenance resource to convey an electronic signature associated with authorizations recorded in a Consent resource

Formal Views of Profile Content

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

This structure is derived from Provenance

Summary

Mandatory: 7 elements
Must-Support: 8 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... signature S1..*SignatureSignature on target
.... type S1..*CodingIndication of the reason the entity signed the object(s)
Fixed Value: As shown
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.7
..... display1..1stringRepresentation defined by the system
Fixed Value: Consent Signature
.... when S1..1instantWhen the signature was created
.... who S1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile)Signer
.... onBehalfOf S0..1Reference(US Core Patient Profile)The party represented
.... targetFormat S1..1codeThe technical format of the signed resources
.... sigFormat S1..1codeThe technical format of the signature
Fixed Value: application/jose
.... data S1..1base64BinaryThe actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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
... target Σ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent 1..*BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

.... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
.... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature S1..*SignatureSignature on target
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type SΣ1..*CodingIndication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.



Fixed Value: As shown
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.7
..... display1..1stringRepresentation defined by the system
Fixed Value: Consent Signature
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... when SΣ1..1instantWhen the signature was created
.... who SΣ1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile)Signer
.... onBehalfOf SΣ0..1Reference(US Core Patient Profile)The party represented
.... targetFormat S1..1codeThe technical format of the signed resources
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

.... sigFormat S1..1codeThe technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/jose
.... data S1..1base64BinaryThe actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... signature 1..*SignatureSignature on target
.... type Σ1..*CodingIndication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.



Fixed Value: As shown
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.7
..... display1..1stringRepresentation defined by the system
Fixed Value: Consent Signature
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... when Σ1..1instantWhen the signature was created
.... who Σ1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile)Signer
.... onBehalfOf Σ0..1Reference(US Core Patient Profile)The party represented
.... targetFormat 1..1codeThe technical format of the signed resources
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

.... sigFormat 1..1codeThe technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/jose
.... data 1..1base64BinaryThe actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

This structure is derived from Provenance

Summary

Mandatory: 7 elements
Must-Support: 8 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... signature S1..*SignatureSignature on target
.... type S1..*CodingIndication of the reason the entity signed the object(s)
Fixed Value: As shown
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.7
..... display1..1stringRepresentation defined by the system
Fixed Value: Consent Signature
.... when S1..1instantWhen the signature was created
.... who S1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile)Signer
.... onBehalfOf S0..1Reference(US Core Patient Profile)The party represented
.... targetFormat S1..1codeThe technical format of the signed resources
.... sigFormat S1..1codeThe technical format of the signature
Fixed Value: application/jose
.... data S1..1base64BinaryThe actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..*ProvenanceWho, What, When for a set of resources
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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
... target Σ1..*Reference(Resource)Target Reference(s) (usually version specific)
... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded Σ1..1instantWhen the activity was recorded / updated
... policy 0..*uriPolicy or plan the activity was defined by
... location 0..1Reference(Location)Where the activity occurred, if relevant
... reason 0..*CodeableConceptReason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1CodeableConceptActivity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent 1..*BackboneElementActor involved
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptHow the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.

.... role 0..*CodeableConceptWhat the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who Σ1..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who participated
.... onBehalfOf 0..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization)Who the agent is representing
... entity 0..*BackboneElementAn entity used in this activity
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ1..1codederivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ1..1Reference(Resource)Identity of entity
.... agent 0..*See agent (Provenance)Entity is attributed to this agent
... signature S1..*SignatureSignature on target
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type SΣ1..*CodingIndication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.



Fixed Value: As shown
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: urn:iso-astm:E1762-95:2013
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1.2.840.10065.1.12.1.7
..... display1..1stringRepresentation defined by the system
Fixed Value: Consent Signature
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... when SΣ1..1instantWhen the signature was created
.... who SΣ1..1Reference(US Core Patient Profile | RelatedPerson | US Core Practitioner Profile)Signer
.... onBehalfOf SΣ0..1Reference(US Core Patient Profile)The party represented
.... targetFormat S1..1codeThe technical format of the signed resources
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

.... sigFormat S1..1codeThe technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/jose
.... data S1..1base64BinaryThe actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Provenance.languagepreferredCommonLanguages
Max Binding: AllLanguages
Provenance.reasonextensiblePurposeOfUse
Provenance.activityextensibleProvenanceActivityType
Provenance.agent.typeextensibleProvenanceParticipantType
Provenance.agent.roleexampleSecurityRoleType
Provenance.entity.rolerequiredProvenanceEntityRole
Provenance.signature.typepreferredFixed Value: 1.2.840.10065.1.12.1.7("Consent Signature")
Provenance.signature.targetFormatrequiredMime Types
Provenance.signature.sigFormatrequiredFixed Value: application/jose

Constraints

IdGradePathDetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorProvenance.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorProvenance.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorProvenance.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorProvenance.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorProvenance.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.occurred[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.recordedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.policyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.activityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.agentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.agent.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorProvenance.agent.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorProvenance.agent.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorProvenance.agent.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorProvenance.agent.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.agent.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.agent.whoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.agent.onBehalfOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.entityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.entity.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorProvenance.entity.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorProvenance.entity.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorProvenance.entity.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorProvenance.entity.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.entity.whatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.entity.agentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signature.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorProvenance.signature.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorProvenance.signature.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signature.whenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signature.whoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signature.onBehalfOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signature.targetFormatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signature.sigFormatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorProvenance.signature.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())