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/patient-provenance | Version: 0.37.0 | |||
| Draft as of 2024-01-11 | Computable Name: ResMedPatientProvenance | |||
Profile of core Provenance resource used for capturing patient record changes
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..1 | Reference(Patient) | Target Reference(s) (usually version specific) | |
  Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by pattern:$this | |
   reason:coordOfCare | 1..1 | 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: COC | |
 activity | 1..1 | CodeableConcept | Activity that occurred Binding: ResMed Provenance activity type ValueSet (extensible) | |
| agent | 1..1 | BackboneElement | Actor involved | |
| type | 1..1 | CodeableConcept | How the agent participated 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-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by pattern:$this | |
| role:provider | 1..1 | CodeableConcept | What the agents role was 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-RoleClass | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PROV | |
| entity | 1..* | BackboneElement | An entity used in this activity | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.activity | extensible | ResMedProvenanceActivityTypeValueSet |
| 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..1 | Reference(Patient) | Target Reference(s) (usually version specific) |
| recorded | Σ | 1..1 | instant | When the activity was recorded / updated |
| Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by pattern:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |
| reason:coordOfCare | 1..1 | 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: COC | |
 activity | 1..1 | CodeableConcept | Activity that occurred Binding: ResMed Provenance activity type ValueSet (extensible) | |
| agent | 1..1 | BackboneElement | Actor involved | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 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 |
| 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-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by pattern:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
| role:provider | 1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role 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/v3-RoleClass | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PROV | |
| who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
| entity | 1..* | BackboneElement | An entity used in this activity | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
| what | Σ | 1..1 | Reference(Resource) | Identity of entity |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Provenance.reason | extensible | PurposeOfUse |
| Provenance.reason:coordOfCare | extensible | Pattern: COC |
| Provenance.activity | extensible | ResMedProvenanceActivityTypeValueSet |
| Provenance.agent.type | extensible | Pattern: PRF |
| Provenance.agent.role | example | SecurityRoleType |
| Provenance.agent.role:provider | example | Pattern: PROV |
| Provenance.entity.role | required | ProvenanceEntityRole |
| 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..1 | Reference(Patient) | Target Reference(s) (usually version specific) | ||||
 occurred[x] | 0..1 | When the activity occurred | ||||||
| occurredPeriod | Period | |||||||
| occurredDateTime | dateTime | |||||||
| recorded | Σ | 1..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 | |||||
| Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by pattern:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| reason:coordOfCare | 1..1 | 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: COC | |||||
| 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 | 1..1 | CodeableConcept | Activity that occurred Binding: ResMed Provenance activity type ValueSet (extensible) | |||||
| agent | 1..1 | BackboneElement | Actor involved | |||||
| 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 | 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 | ||||
| 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-ParticipationType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||
| 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 | |||||
| Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by pattern:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| role:provider | 1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role 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/v3-RoleClass | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PROV | |||||
| 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 | |||||
| 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 | |||||
| entity | 1..* | 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 | derivation | revision | quotation | source | 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 / Code | ||||
| Provenance.language | preferred | CommonLanguages
| ||||
| Provenance.reason | extensible | PurposeOfUse | ||||
| Provenance.reason:coordOfCare | extensible | Pattern: COC | ||||
| Provenance.activity | extensible | ResMedProvenanceActivityTypeValueSet | ||||
| Provenance.agent.type | extensible | Pattern: PRF | ||||
| Provenance.agent.role | example | SecurityRoleType | ||||
| Provenance.agent.role:provider | example | Pattern: PROV | ||||
| Provenance.entity.role | required | ProvenanceEntityRole |
| 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: 7 elements
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..1 | Reference(Patient) | Target Reference(s) (usually version specific) | |
| Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by pattern:$this | |
| reason:coordOfCare | 1..1 | 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: COC | |
| activity | 1..1 | CodeableConcept | Activity that occurred Binding: ResMed Provenance activity type ValueSet (extensible) | |
| agent | 1..1 | BackboneElement | Actor involved | |
| type | 1..1 | CodeableConcept | How the agent participated 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-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by pattern:$this | |
| role:provider | 1..1 | CodeableConcept | What the agents role was 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-RoleClass | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PROV | |
| entity | 1..* | BackboneElement | An entity used in this activity | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Provenance.activity | extensible | ResMedProvenanceActivityTypeValueSet |
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..1 | Reference(Patient) | Target Reference(s) (usually version specific) |
| recorded | Σ | 1..1 | instant | When the activity was recorded / updated |
| Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by pattern:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |
| reason:coordOfCare | 1..1 | 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: COC | |
| activity | 1..1 | CodeableConcept | Activity that occurred Binding: ResMed Provenance activity type ValueSet (extensible) | |
| agent | 1..1 | BackboneElement | Actor involved | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 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 |
| 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-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |
| Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by pattern:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |
| role:provider | 1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role 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/v3-RoleClass | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PROV | |
| who | Σ | 1..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who participated |
| entity | 1..* | BackboneElement | An entity used in this activity | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | Σ | 1..1 | code | derivation | revision | quotation | source | removal Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
| what | Σ | 1..1 | Reference(Resource) | Identity of entity |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Provenance.reason | extensible | PurposeOfUse |
| Provenance.reason:coordOfCare | extensible | Pattern: COC |
| Provenance.activity | extensible | ResMedProvenanceActivityTypeValueSet |
| Provenance.agent.type | extensible | Pattern: PRF |
| Provenance.agent.role | example | SecurityRoleType |
| Provenance.agent.role:provider | example | Pattern: PROV |
| Provenance.entity.role | required | ProvenanceEntityRole |
| 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..1 | Reference(Patient) | Target Reference(s) (usually version specific) | ||||
| occurred[x] | 0..1 | When the activity occurred | ||||||
| occurredPeriod | Period | |||||||
| occurredDateTime | dateTime | |||||||
| recorded | Σ | 1..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 | |||||
| Slices for reason | 1..* | CodeableConcept | Reason the activity is occurring Slice: Unordered, Open by pattern:$this Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| reason:coordOfCare | 1..1 | 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: COC | |||||
| 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 | 1..1 | CodeableConcept | Activity that occurred Binding: ResMed Provenance activity type ValueSet (extensible) | |||||
| agent | 1..1 | BackboneElement | Actor involved | |||||
| 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 | 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 | ||||
| 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-ParticipationType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||
| 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 | |||||
| Slices for role | 1..* | CodeableConcept | What the agents role was Slice: Unordered, Open by pattern:$this Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| role:provider | 1..1 | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role 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/v3-RoleClass | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PROV | |||||
| 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 | |||||
| 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 | |||||
| entity | 1..* | 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 | derivation | revision | quotation | source | 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 / Code | ||||
| Provenance.language | preferred | CommonLanguages
| ||||
| Provenance.reason | extensible | PurposeOfUse | ||||
| Provenance.reason:coordOfCare | extensible | Pattern: COC | ||||
| Provenance.activity | extensible | ResMedProvenanceActivityTypeValueSet | ||||
| Provenance.agent.type | extensible | Pattern: PRF | ||||
| Provenance.agent.role | example | SecurityRoleType | ||||
| Provenance.agent.role:provider | example | Pattern: PROV | ||||
| Provenance.entity.role | required | ProvenanceEntityRole |
| 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: 7 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron