ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide - Local Development build (v0.37.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://resmed.com/fhir/core/StructureDefinition/provenance-fhirhose | Version: 0.37.0 | |||
| Draft as of 2024-01-11 | Computable Name: ResMedFhirHoseProvenance | |||
Profile of Provenance resource to track content synchronized via the FHIR Hose
Each resource created through FHIR Hose should be accompanied by a ResMed FHIR Hose Provenance Profile resource identifying the sources of the content. Each Provenance resource can reference multiple changed resources and multiple sources. Usually only a single changed resource is listed, however, including multiple resources might occur when a change to one ECO DB entity results in multiple changed resources. Unrelated changes should not be listed in the same Provenance simply because they are submitted together (e.g. changes to multiple Provenance resources in the same bundle). The Provenance resource contains information for, at most, one patient.
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 | |
  target | 1..* | Reference(Resource) | Version-specific reference to each changed resource. | |
 occurred[x] | 1..1 | dateTime | When the ECO DB change occurred | |
| recorded | 1..1 | instant | When the change was processed and submitted to CHP | |
 reason | 0..* | CodeableConcept | Reason the activity is occurring 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/v3-ActReason | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RECORDMGT | |
| activity | 0..1 | CodeableConcept | Activity that occurred Binding: ResMed FHIR Hose Provenance Activity ValueSet (required) | |
 Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type | |
  agent:fhirHose | 1..1 | BackboneElement | The FHIR Hose application submitting the resources | |
 type | 1..1 | CodeableConcept | Assembler 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 | |
 role | 0..* | CodeableConcept | Application | |
  who | 1..1 | Reference(ResMed FHIR Hose Software Profile) | Who participated | |
| entity | 1..* | BackboneElement | Each ECO DB entity used to prepare the resource | |
| role | 1..1 | code | The role the ECO DB entity played Binding: ResMed FHIR Hose Provenance Role ValueSet (required) | |
| what | 1..1 | Reference(Resource) | The ECO DB entity reference of the contributing entity | |
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.activity | required | ValueSetResMedFhirHoseActivity |
| Provenance.entity.role | required | ValueSetResMedFhirHoseRole |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| target | Σ | 1..* | Reference(Resource) | Version-specific reference to each changed resource. |
| occurred[x] | 1..1 | dateTime | When the ECO DB change occurred | |
| recorded | Σ | 1..1 | instant | When the change was processed and submitted to CHP |
 reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. 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/v3-ActReason | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RECORDMGT | |
| activity | 0..1 | CodeableConcept | Activity that occurred Binding: ResMed FHIR Hose Provenance Activity ValueSet (required) | |
| Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type | |
 agent:All Slices | Content/Rules for all slices | |||
  modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
| agent:fhirHose | 1..1 | BackboneElement | The FHIR Hose application submitting the resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | Assembler Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 | |
| role | 0..* | CodeableConcept | Application Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
| who | Σ | 1..1 | Reference(ResMed FHIR Hose Software Profile) | Who participated |
| entity | 1..* | BackboneElement | Each ECO DB entity used to prepare the resource | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | Σ | 1..1 | code | The role the ECO DB entity played Binding: ResMed FHIR Hose Provenance Role ValueSet (required) |
| what | Σ | 1..1 | Reference(Resource) | The ECO DB entity reference of the contributing entity |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Provenance.reason | extensible | Pattern: RECORDMGT |
| Provenance.activity | required | ValueSetResMedFhirHoseActivity |
| Provenance.agent:fhirHose.type | extensible | Pattern: assembler |
| Provenance.agent:fhirHose.role | example | SecurityRoleType |
| Provenance.entity.role | required | ValueSetResMedFhirHoseRole |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 : 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-4 | error | Provenance | If 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target | Σ | 1..* | Reference(Resource) | Version-specific reference to each changed resource. | ||||
| occurred[x] | 1..1 | dateTime | When the ECO DB change occurred | |||||
| recorded | Σ | 1..1 | instant | When the change was processed and submitted to CHP | ||||
| policy | 0..* | uri | Policy or plan the activity was defined by | |||||
| location | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RECORDMGT | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| activity | 0..1 | CodeableConcept | Activity that occurred Binding: ResMed FHIR Hose Provenance Activity ValueSet (required) | |||||
| Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type | |||||
| agent:All Slices | Content/Rules for all slices | |||||||
| 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: ProvenanceParticipantType (extensible): 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 | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||
| onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:fhirHose | 1..1 | BackboneElement | The FHIR Hose application submitting the resources | |||||
| 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 | Σ | 1..1 | CodeableConcept | Assembler Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assembler | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| role | 0..* | CodeableConcept | Application Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who | Σ | 1..1 | Reference(ResMed FHIR Hose Software Profile) | Who participated | ||||
| onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| entity | 1..* | BackboneElement | Each ECO DB entity used to prepare the resource | |||||
| 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 | The role the ECO DB entity played Binding: ResMed FHIR Hose Provenance Role ValueSet (required) | ||||
| what | Σ | 1..1 | Reference(Resource) | The ECO DB entity reference of the contributing entity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 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). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature | 0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Provenance.language | preferred | CommonLanguages
| ||||
| Provenance.reason | extensible | Pattern: RECORDMGT | ||||
| Provenance.activity | required | ValueSetResMedFhirHoseActivity | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantType | ||||
| Provenance.agent.role | example | SecurityRoleType | ||||
| Provenance.agent:fhirHose.type | extensible | Pattern: assembler | ||||
| Provenance.agent:fhirHose.role | example | SecurityRoleType | ||||
| Provenance.entity.role | required | ValueSetResMedFhirHoseRole | ||||
| Provenance.entity.what.type | extensible | ResourceType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 : 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-4 | error | Provenance | If 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Provenance
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
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 | |
| target | 1..* | Reference(Resource) | Version-specific reference to each changed resource. | |
| occurred[x] | 1..1 | dateTime | When the ECO DB change occurred | |
| recorded | 1..1 | instant | When the change was processed and submitted to CHP | |
| reason | 0..* | CodeableConcept | Reason the activity is occurring 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/v3-ActReason | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RECORDMGT | |
| activity | 0..1 | CodeableConcept | Activity that occurred Binding: ResMed FHIR Hose Provenance Activity ValueSet (required) | |
| Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type | |
| agent:fhirHose | 1..1 | BackboneElement | The FHIR Hose application submitting the resources | |
| type | 1..1 | CodeableConcept | Assembler 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 | |
| role | 0..* | CodeableConcept | Application | |
| who | 1..1 | Reference(ResMed FHIR Hose Software Profile) | Who participated | |
| entity | 1..* | BackboneElement | Each ECO DB entity used to prepare the resource | |
| role | 1..1 | code | The role the ECO DB entity played Binding: ResMed FHIR Hose Provenance Role ValueSet (required) | |
| what | 1..1 | Reference(Resource) | The ECO DB entity reference of the contributing entity | |
| identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.activity | required | ValueSetResMedFhirHoseActivity |
| Provenance.entity.role | required | ValueSetResMedFhirHoseRole |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance | 0..* | Provenance | Who, What, When for a set of resources | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| target | Σ | 1..* | Reference(Resource) | Version-specific reference to each changed resource. |
| occurred[x] | 1..1 | dateTime | When the ECO DB change occurred | |
| recorded | Σ | 1..1 | instant | When the change was processed and submitted to CHP |
| reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. 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/v3-ActReason | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RECORDMGT | |
| activity | 0..1 | CodeableConcept | Activity that occurred Binding: ResMed FHIR Hose Provenance Activity ValueSet (required) | |
| Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type | |
| agent:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
| agent:fhirHose | 1..1 | BackboneElement | The FHIR Hose application submitting the resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | Assembler Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. 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 | |
| role | 0..* | CodeableConcept | Application Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
| who | Σ | 1..1 | Reference(ResMed FHIR Hose Software Profile) | Who participated |
| entity | 1..* | BackboneElement | Each ECO DB entity used to prepare the resource | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | Σ | 1..1 | code | The role the ECO DB entity played Binding: ResMed FHIR Hose Provenance Role ValueSet (required) |
| what | Σ | 1..1 | Reference(Resource) | The ECO DB entity reference of the contributing entity |
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Provenance.reason | extensible | Pattern: RECORDMGT |
| Provenance.activity | required | ValueSetResMedFhirHoseActivity |
| Provenance.agent:fhirHose.type | extensible | Pattern: assembler |
| Provenance.agent:fhirHose.role | example | SecurityRoleType |
| Provenance.entity.role | required | ValueSetResMedFhirHoseRole |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 : 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-4 | error | Provenance | If 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target | Σ | 1..* | Reference(Resource) | Version-specific reference to each changed resource. | ||||
| occurred[x] | 1..1 | dateTime | When the ECO DB change occurred | |||||
| recorded | Σ | 1..1 | instant | When the change was processed and submitted to CHP | ||||
| policy | 0..* | uri | Policy or plan the activity was defined by | |||||
| location | 0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason | 0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RECORDMGT | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| activity | 0..1 | CodeableConcept | Activity that occurred Binding: ResMed FHIR Hose Provenance Activity ValueSet (required) | |||||
| Slices for agent | 1..* | BackboneElement | Actor involved Slice: Unordered, Open by pattern:type | |||||
| agent:All Slices | Content/Rules for all slices | |||||||
| 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: ProvenanceParticipantType (extensible): 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 | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated | ||||
| onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| agent:fhirHose | 1..1 | BackboneElement | The FHIR Hose application submitting the resources | |||||
| 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 | Σ | 1..1 | CodeableConcept | Assembler Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assembler | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| role | 0..* | CodeableConcept | Application Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who | Σ | 1..1 | Reference(ResMed FHIR Hose Software Profile) | Who participated | ||||
| onBehalfOf | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| entity | 1..* | BackboneElement | Each ECO DB entity used to prepare the resource | |||||
| 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 | The role the ECO DB entity played Binding: ResMed FHIR Hose Provenance Role ValueSet (required) | ||||
| what | Σ | 1..1 | Reference(Resource) | The ECO DB entity reference of the contributing entity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 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). | ||||
| identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| agent | 0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature | 0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Provenance.language | preferred | CommonLanguages
| ||||
| Provenance.reason | extensible | Pattern: RECORDMGT | ||||
| Provenance.activity | required | ValueSetResMedFhirHoseActivity | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantType | ||||
| Provenance.agent.role | example | SecurityRoleType | ||||
| Provenance.agent:fhirHose.type | extensible | Pattern: assembler | ||||
| Provenance.agent:fhirHose.role | example | SecurityRoleType | ||||
| Provenance.entity.role | required | ValueSetResMedFhirHoseRole | ||||
| Provenance.entity.what.type | extensible | ResourceType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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 : 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-4 | error | Provenance | If 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Provenance
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron