SPL Mapping FHIR R5 Implementation Guide
0.2.5 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.5 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: DualSubmissionProvenance

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/DualSubmissionProvenance Version: 0.2.5
Standards status: Trial-use Maturity Level: 1 Computable Name: DualSubmissionProvenance

A profile that links changes made to a FHIR system either via a converted SPL document or that are sent to a SPL system

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance 0..* Provenance Who, What, When for a set of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... occurred[x] S 1..1 When the activity occurred
ele-1: All FHIR elements must have a @value or children
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 0..1 instant When the activity was recorded / updated
ele-1: All FHIR elements must have a @value or children
... activity S 1..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (example): The activity that took place.


ele-1: All FHIR elements must have a @value or children
... agent SΣC 1..1 BackboneElement Actor involved
ele-1: All FHIR elements must have a @value or children
prov-1: Who and onBehalfOf cannot be the same
prov-2: If who is a PractitionerRole, onBehalfOf can't reference the same Practitioner
prov-3: If who is an organization, onBehalfOf can't be a PractitionerRole within that organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ParticipationRoleType (example): The type of participation that a provenance agent played with respect to the activity.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assembler
.... who SΣC 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The agent that participated in the event
ele-1: All FHIR elements must have a @value or children
.... onBehalfOf C 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) The agent that delegated
ele-1: All FHIR elements must have a @value or children
... entity SΣ 1..* BackboneElement An entity used in this activity
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... role SΣ 1..1 code revision | quotation | source | instantiates | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.


ele-1: All FHIR elements must have a @value or children
Required Pattern: source
.... what Σ 1..1 Reference(SPLDocumentReference | ProductSubmissionDocument | RegistrantOrganization | LabelerOrganization | EstablishmentOrganization | GDUFAFacilityOrganization) Identity of entity
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.activityexampleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeexamplePattern: assembler
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
Provenance.entity.rolerequiredPattern: source
http://hl7.org/fhir/ValueSet/provenance-entity-role|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prov-1errorProvenance.agentWho and onBehalfOf cannot be the same
: who.resolve().exists() and onBehalfOf.resolve().exists() implies who.resolve() != onBehalfOf.resolve()
prov-2errorProvenance.agentIf who is a PractitionerRole, onBehalfOf can't reference the same Practitioner
: who.resolve().ofType(PractitionerRole).practitioner.resolve().exists() and onBehalfOf.resolve().ofType(Practitioner).exists() implies who.resolve().practitioner.resolve() != onBehalfOf.resolve()
prov-3errorProvenance.agentIf who is an organization, onBehalfOf can't be a PractitionerRole within that organization
: who.resolve().ofType(Organization).exists() and onBehalfOf.resolve().ofType(PractitionerRole).organization.resolve().exists() implies who.resolve() != onBehalfOf.resolve().organization.resolve()

 

Other representations of profile: CSV, Excel, Schematron