Gravitate Health FHIR Implementation Guide
0.1.0 - CI Build
Gravitate Health FHIR Implementation Guide
0.1.0 - CI Build
Gravitate Health FHIR Implementation Guide, published by Gravitate Health Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/gravitate-health/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/ProvenanceGH | Version: 0.1.0 | |||
| Active as of 2024-12-20 | Computable Name: ProvenanceGH | |||
Provenance Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   BlockchainTransactionId |
1..1 | string | Blockchain Transaction ID URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/blockchain-transaction-id | |
  target |
1..* | Reference(DocumentReference | Bundle | Composition) | Target Reference(s) (usually version specific) | |
 occurred[x] |
1..1 | dateTime | When the activity occurred | |
  activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.activity | required | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| BlockchainTransactionId |
1..1 | string | Blockchain Transaction ID URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/blockchain-transaction-id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 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 |
| target |
Σ | 1..* | Reference(DocumentReference | Bundle | Composition) | Target Reference(s) (usually version specific) ele-1: All FHIR elements must have a @value or children |
| occurred[x] |
1..1 | dateTime | When the activity occurred ele-1: All FHIR elements must have a @value or children | |
 activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (required) ele-1: All FHIR elements must have a @value or children | |
 agent |
ΣC | 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 |
| who |
Σ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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.activity | required | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| BlockchainTransactionId |
1..1 | string | Blockchain Transaction ID URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/blockchain-transaction-id | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
Σ | 1..* | Reference(DocumentReference | Bundle | Composition) | Target Reference(s) (usually version specific) | ||||
| occurred[x] |
1..1 | dateTime | When the activity occurred | |||||
| recorded |
Σ | 0..1 | instant | When the activity was recorded / updated | ||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| authorization |
0..* | CodeableReference() | Authorization (purposeOfUse) related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | |||||
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (required) | |||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | |||||
| patient |
0..1 | Reference(Patient) | The patient is the subject of the data created/updated (.target) by the activity | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
| agent |
ΣC | 1..* | BackboneElement | Actor involved 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | CodeableConcept | How the agent participated Binding: ParticipationRoleType (example): The type of participation that a provenance agent played with respect to the activity. | ||||
| role |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
ΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event | ||||
| onBehalfOf |
C | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated | ||||
| entity |
Σ | 0..* | BackboneElement | An entity used in this activity | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 1..1 | code | revision | quotation | source | instantiates | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
| what |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| Provenance.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| Provenance.authorization | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Provenance.activity | required | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard | |
| Provenance.agent.type | example | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|5.0.0from the FHIR Standard |
This structure is derived from Provenance
Differential View
This structure is derived from Provenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| BlockchainTransactionId |
1..1 | string | Blockchain Transaction ID URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/blockchain-transaction-id | |
| target |
1..* | Reference(DocumentReference | Bundle | Composition) | Target Reference(s) (usually version specific) | |
| occurred[x] |
1..1 | dateTime | When the activity occurred | |
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.activity | required | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| BlockchainTransactionId |
1..1 | string | Blockchain Transaction ID URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/blockchain-transaction-id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| 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 |
| target |
Σ | 1..* | Reference(DocumentReference | Bundle | Composition) | Target Reference(s) (usually version specific) ele-1: All FHIR elements must have a @value or children |
| occurred[x] |
1..1 | dateTime | When the activity occurred ele-1: All FHIR elements must have a @value or children | |
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (required) ele-1: All FHIR elements must have a @value or children | |
| agent |
ΣC | 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 |
| who |
Σ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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.activity | required | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | Provenance | Who, What, When for a set of resources | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| BlockchainTransactionId |
1..1 | string | Blockchain Transaction ID URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/blockchain-transaction-id | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
Σ | 1..* | Reference(DocumentReference | Bundle | Composition) | Target Reference(s) (usually version specific) | ||||
| occurred[x] |
1..1 | dateTime | When the activity occurred | |||||
| recorded |
Σ | 0..1 | instant | When the activity was recorded / updated | ||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| authorization |
0..* | CodeableReference() | Authorization (purposeOfUse) related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | |||||
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: ProvenanceActivityType (required) | |||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | |||||
| patient |
0..1 | Reference(Patient) | The patient is the subject of the data created/updated (.target) by the activity | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
| agent |
ΣC | 1..* | BackboneElement | Actor involved 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | CodeableConcept | How the agent participated Binding: ParticipationRoleType (example): The type of participation that a provenance agent played with respect to the activity. | ||||
| role |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
ΣC | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The agent that participated in the event | ||||
| onBehalfOf |
C | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient) | The agent that delegated | ||||
| entity |
Σ | 0..* | BackboneElement | An entity used in this activity | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
Σ | 1..1 | code | revision | quotation | source | instantiates | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
| what |
Σ | 1..1 | Reference(Resource) | Identity of entity | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| Provenance.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| Provenance.authorization | example | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Provenance.activity | required | ProvenanceActivityTypehttp://hl7.org/fhir/ValueSet/provenance-activity-typefrom the FHIR Standard | |
| Provenance.agent.type | example | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typefrom the FHIR Standard | |
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | |
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|5.0.0from the FHIR Standard |
This structure is derived from Provenance
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Gravitate Health Project. Package hl7.eu.fhir.gh#0.1.0 based on FHIR 5.0.0. Generated 2024-12-20
Links: Table of Contents |
QA Report
The Gravitate Health project has received funding from the IMI 2 Joint Undertaking under grant agreement No 945334.
This joint undertaking receives support from the EU H2020 research and innovation programme and EFPIA.
