MediRecords FHIR Implementation Guide
1.4.1 - release
| Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-episodeofcare |
| Version: | 1.4.1 |
| Name: | MREpisodeOfCare |
| Title: | MR EpisodeOfCare |
| Status: | Active as of 2024-10-28 02:34:31+0000 |
| Definition: | Episode of Care profile to represent the MediRecords Case record |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-episodeofcare
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EpisodeOfCare
Summary
Mandatory: 15 elements (4 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EpisodeOfCare | EpisodeOfCare | |||
  meta | ||||
  lastUpdated | S | 0..1 | instant | When the resource version last changed |
 security | SC | 0..1 | Coding | Security Labels applied to this resource inv-mr-meta-security-01: Medirecords supports only U, R security code |
 Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Open by type:$this | |
  contained:careteam | S | 0..1 | MRCareTeam | Planned participants in the coordination and delivery of care for a patient or group |
  id | 1..1 | id | Unique id of contained resource within this instance | |
 Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |
| linked-document | S | 0..* | Reference(MR DocumentReference) | Linked referral letter URL: https://fhir.medirecords.com/StructureDefinition/mr-referenced-document-ext |
| urgency | S | 1..1 | code | Urgency URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-priority-ext Binding: RequestPriority (required) |
| topic | S | 1..1 | string | Episode subject (or topic) URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-topic-ext |
| max-sessions | S | 1..1 | integer | Max sessions URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-sessions-ext |
| comment | S | 0..1 | string | Comment URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext |
| Slices for identifier | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Closed by pattern:type | |
 identifier:case-number | S | 1..1 | Identifier | Case Number |
  type | 1..1 | CodeableConcept | Description of identifier 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ECN | |
| value | 1..1 | string | Case No. | |
| identifier:ref-number | S | 0..1 | Identifier | Case Ref. Number |
| type | 1..1 | CodeableConcept | Description of identifier 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ERN | |
| value | 1..1 | string | Reference Number | |
| status | S | 1..1 | code | planned | active | onhold | waitlist | cancelled | finished |
| type | S | 1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: MR Episode Type ValueSet (extensible) |
| diagnosis | 1..* | BackboneElement | Existing problem(s) | |
 condition | S | 1..1 | Reference(MR Condition) | Existing problem |
| reference | 1..1 | string | Reference to existing problem | |
| patient | S | 1..1 | Reference(MR Patient) | The patient who is the focus of this episode of care |
| managingOrganization | S | 1..1 | Reference(MR Organisation) | Practice that initated the case |
| period | 1..1 | Period | Interval during responsibility is assumed | |
| start | S | 1..1 | dateTime | Case start date |
| end | S | 0..1 | dateTime | Expiry date |
| careManager | S | 1..1 | Reference(MR Practitioner) | Care Manager |
| reference | 1..1 | string | Reference to Provider user | |
| team | S | 0..1 | Reference(MR CareTeam) | Case participants (or care team) |
| reference | 1..1 | string | Internal reference to contained CareTeam resource | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | SΣC | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-mr-meta-security-01: Medirecords supports only U, R security code | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Open by type:$this | |||||
| contained:careteam | S | 0..1 | MRCareTeam | Planned participants in the coordination and delivery of care for a patient or group | ||||
 id | SΣ | 1..1 | id | Unique id of contained resource within this instance | ||||
| 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 | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this team | ||||
| status | ?!Σ | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
| category | Σ | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example): Indicates the type of care team. | ||||
| name | Σ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| subject | Σ | 0..1 | Reference(Patient | Group) | Who care team is for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| period | Σ | 0..1 | Period | Time period team covers | ||||
| participant | C | 0..* | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| 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 | Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member | SΣ | 1..1 | Reference(MR Practitioner | MR Organisation Service Provider | MR PractitionerRole Contact) | Care team member | ||||
| 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 | 1..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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Name of team member | ||||
| onBehalfOf | Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period | 0..1 | Period | Time period of participant | |||||
| reasonCode | 0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team. | |||||
| reasonReference | 0..* | Reference(Condition) | Why the care team exists | |||||
| managingOrganization | SΣ | 1..1 | Reference(MR Organisation) | Organization responsible for the care team | ||||
| 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 | 1..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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
| note | 0..* | Annotation | Comments made about the CareTeam | |||||
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| linked-document | S | 0..* | Reference(MR DocumentReference) | Linked referral letter URL: https://fhir.medirecords.com/StructureDefinition/mr-referenced-document-ext | ||||
| urgency | S | 1..1 | code | Urgency URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-priority-ext Binding: RequestPriority (required) | ||||
| topic | S | 1..1 | string | Episode subject (or topic) URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-topic-ext | ||||
| max-sessions | S | 1..1 | integer | Max sessions URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-sessions-ext | ||||
| comment | S | 0..1 | string | Comment URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Closed by pattern:type | |||||
| identifier:case-number | S | 1..1 | Identifier | Case Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ECN | |||||
| 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 | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Case No. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:ref-number | S | 0..1 | Identifier | Case Ref. Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ERN | |||||
| 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 | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Reference Number Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 1..1 | code | planned | active | onhold | waitlist | cancelled | finished Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| 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 | ||||
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period | 1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type | SΣ | 1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: MR Episode Type ValueSet (extensible) | ||||
| diagnosis | Σ | 1..* | BackboneElement | Existing problem(s) | ||||
| 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 | ||||
| condition | SΣ | 1..1 | Reference(MR Condition) | Existing problem | ||||
| 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 | 1..1 | string | Reference to existing problem | ||||
| 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| role | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient | SΣ | 1..1 | Reference(MR Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization | SΣ | 1..1 | Reference(MR Organisation) | Practice that initated the case | ||||
| period | Σ | 1..1 | Period | Interval during responsibility is assumed | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 1..1 | dateTime | Case start date | ||||
| end | SΣC | 0..1 | dateTime | Expiry date | ||||
| referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager | S | 1..1 | Reference(MR Practitioner) | Care Manager | ||||
| 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 | 1..1 | string | Reference to Provider user | ||||
| 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| team | S | 0..1 | Reference(MR CareTeam) | Case participants (or care team) | ||||
| 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 | 1..1 | string | Internal reference to contained CareTeam resource | ||||
| 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| security | ΣC | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-mr-meta-security-01: Medirecords supports only U, R security code |
| contained:careteam | 0..1 | MRCareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
| id | Σ | 1..1 | id | Unique id of contained resource within this instance |
| participant | C | 0..* | BackboneElement | Members of the team |
| member | Σ | 1..1 | Reference(MR Practitioner | MR Organisation Service Provider | MR PractitionerRole Contact) | Care team member |
| managingOrganization | Σ | 1..1 | Reference(MR Organisation) | Organization responsible for the care team |
| linked-document | 0..* | Reference(MR DocumentReference) | Linked referral letter URL: https://fhir.medirecords.com/StructureDefinition/mr-referenced-document-ext | |
| urgency | 1..1 | code | Urgency URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-priority-ext Binding: RequestPriority (required) | |
| topic | 1..1 | string | Episode subject (or topic) URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-topic-ext | |
| max-sessions | 1..1 | integer | Max sessions URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-sessions-ext | |
| comment | 0..1 | string | Comment URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext | |
| identifier:case-number | 1..1 | Identifier | Case Number | |
| identifier:ref-number | 0..1 | Identifier | Case Ref. Number | |
| status | ?!Σ | 1..1 | code | planned | active | onhold | waitlist | cancelled | finished Binding: EpisodeOfCareStatus (required): The status of the episode of care. |
| type | Σ | 1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: MR Episode Type ValueSet (extensible) |
| diagnosis | Σ | 1..* | BackboneElement | Existing problem(s) |
| condition | Σ | 1..1 | Reference(MR Condition) | Existing problem |
| patient | Σ | 1..1 | Reference(MR Patient) | The patient who is the focus of this episode of care |
| managingOrganization | Σ | 1..1 | Reference(MR Organisation) | Practice that initated the case |
| period | Σ | 1..1 | Period | Interval during responsibility is assumed |
| start | ΣC | 1..1 | dateTime | Case start date |
| end | ΣC | 0..1 | dateTime | Expiry date |
| careManager | 1..1 | Reference(MR Practitioner) | Care Manager | |
| team | 0..1 | Reference(MR CareTeam) | Case participants (or care team) | |
| Documentation for this format | ||||
This structure is derived from EpisodeOfCare
Summary
Mandatory: 15 elements (4 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare | EpisodeOfCare | |||
| meta | ||||
| lastUpdated | S | 0..1 | instant | When the resource version last changed |
| security | SC | 0..1 | Coding | Security Labels applied to this resource inv-mr-meta-security-01: Medirecords supports only U, R security code |
| Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Open by type:$this | |
| contained:careteam | S | 0..1 | MRCareTeam | Planned participants in the coordination and delivery of care for a patient or group |
| id | 1..1 | id | Unique id of contained resource within this instance | |
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |
| linked-document | S | 0..* | Reference(MR DocumentReference) | Linked referral letter URL: https://fhir.medirecords.com/StructureDefinition/mr-referenced-document-ext |
| urgency | S | 1..1 | code | Urgency URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-priority-ext Binding: RequestPriority (required) |
| topic | S | 1..1 | string | Episode subject (or topic) URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-topic-ext |
| max-sessions | S | 1..1 | integer | Max sessions URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-sessions-ext |
| comment | S | 0..1 | string | Comment URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext |
| Slices for identifier | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Closed by pattern:type | |
| identifier:case-number | S | 1..1 | Identifier | Case Number |
| type | 1..1 | CodeableConcept | Description of identifier 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ECN | |
| value | 1..1 | string | Case No. | |
| identifier:ref-number | S | 0..1 | Identifier | Case Ref. Number |
| type | 1..1 | CodeableConcept | Description of identifier 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ERN | |
| value | 1..1 | string | Reference Number | |
| status | S | 1..1 | code | planned | active | onhold | waitlist | cancelled | finished |
| type | S | 1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: MR Episode Type ValueSet (extensible) |
| diagnosis | 1..* | BackboneElement | Existing problem(s) | |
| condition | S | 1..1 | Reference(MR Condition) | Existing problem |
| reference | 1..1 | string | Reference to existing problem | |
| patient | S | 1..1 | Reference(MR Patient) | The patient who is the focus of this episode of care |
| managingOrganization | S | 1..1 | Reference(MR Organisation) | Practice that initated the case |
| period | 1..1 | Period | Interval during responsibility is assumed | |
| start | S | 1..1 | dateTime | Case start date |
| end | S | 0..1 | dateTime | Expiry date |
| careManager | S | 1..1 | Reference(MR Practitioner) | Care Manager |
| reference | 1..1 | string | Reference to Provider user | |
| team | S | 0..1 | Reference(MR CareTeam) | Case participants (or care team) |
| reference | 1..1 | string | Internal reference to contained CareTeam resource | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | SΣC | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-mr-meta-security-01: Medirecords supports only U, R security code | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for contained | 0..* | Resource | Contained, inline Resources Slice: Unordered, Open by type:$this | |||||
| contained:careteam | S | 0..1 | MRCareTeam | Planned participants in the coordination and delivery of care for a patient or group | ||||
| id | SΣ | 1..1 | id | Unique id of contained resource within this instance | ||||
| 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 | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this team | ||||
| status | ?!Σ | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
| category | Σ | 0..* | CodeableConcept | Type of team Binding: CareTeamCategory (example): Indicates the type of care team. | ||||
| name | Σ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| subject | Σ | 0..1 | Reference(Patient | Group) | Who care team is for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| period | Σ | 0..1 | Period | Time period team covers | ||||
| participant | C | 0..* | BackboneElement | Members of the team ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner | ||||
| 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 | Σ | 0..* | CodeableConcept | Type of involvement Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| member | SΣ | 1..1 | Reference(MR Practitioner | MR Organisation Service Provider | MR PractitionerRole Contact) | Care team member | ||||
| 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 | 1..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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Name of team member | ||||
| onBehalfOf | Σ | 0..1 | Reference(Organization) | Organization of the practitioner | ||||
| period | 0..1 | Period | Time period of participant | |||||
| reasonCode | 0..* | CodeableConcept | Why the care team exists Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team. | |||||
| reasonReference | 0..* | Reference(Condition) | Why the care team exists | |||||
| managingOrganization | SΣ | 1..1 | Reference(MR Organisation) | Organization responsible for the care team | ||||
| 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 | 1..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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
| note | 0..* | Annotation | Comments made about the CareTeam | |||||
| Slices for extension | 3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| linked-document | S | 0..* | Reference(MR DocumentReference) | Linked referral letter URL: https://fhir.medirecords.com/StructureDefinition/mr-referenced-document-ext | ||||
| urgency | S | 1..1 | code | Urgency URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-priority-ext Binding: RequestPriority (required) | ||||
| topic | S | 1..1 | string | Episode subject (or topic) URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-topic-ext | ||||
| max-sessions | S | 1..1 | integer | Max sessions URL: https://fhir.medirecords.com/StructureDefinition/mr-episode-sessions-ext | ||||
| comment | S | 0..1 | string | Comment URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare Slice: Unordered, Closed by pattern:type | |||||
| identifier:case-number | S | 1..1 | Identifier | Case Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ECN | |||||
| 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 | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Case No. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:ref-number | S | 0..1 | Identifier | Case Ref. Number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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: https://fhir.medirecords.com/CodeSystem/mr-identifier-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ERN | |||||
| 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 | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Reference Number Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 1..1 | code | planned | active | onhold | waitlist | cancelled | finished Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| 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 | ||||
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period | 1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type | SΣ | 1..1 | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: MR Episode Type ValueSet (extensible) | ||||
| diagnosis | Σ | 1..* | BackboneElement | Existing problem(s) | ||||
| 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 | ||||
| condition | SΣ | 1..1 | Reference(MR Condition) | Existing problem | ||||
| 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 | 1..1 | string | Reference to existing problem | ||||
| 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| role | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient | SΣ | 1..1 | Reference(MR Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization | SΣ | 1..1 | Reference(MR Organisation) | Practice that initated the case | ||||
| period | Σ | 1..1 | Period | Interval during responsibility is assumed | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 1..1 | dateTime | Case start date | ||||
| end | SΣC | 0..1 | dateTime | Expiry date | ||||
| referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |||||
| careManager | S | 1..1 | Reference(MR Practitioner) | Care Manager | ||||
| 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 | 1..1 | string | Reference to Provider user | ||||
| 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| team | S | 0..1 | Reference(MR CareTeam) | Case participants (or care team) | ||||
| 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 | 1..1 | string | Internal reference to contained CareTeam resource | ||||
| 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code | URI | |||
| EpisodeOfCare.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| EpisodeOfCare.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| EpisodeOfCare.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| EpisodeOfCare.contained:careteam.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| EpisodeOfCare.contained:careteam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.contained:careteam.category | example | CareTeamCategoryhttp://hl7.org/fhir/ValueSet/care-team-categoryfrom the FHIR Standard | ||||
| EpisodeOfCare.contained:careteam.participant.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| EpisodeOfCare.contained:careteam.participant.member.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| EpisodeOfCare.contained:careteam.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| EpisodeOfCare.contained:careteam.managingOrganization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| EpisodeOfCare.identifier:case-number.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.identifier:case-number.type | extensible | Pattern: ECNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| EpisodeOfCare.identifier:ref-number.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.identifier:ref-number.type | extensible | Pattern: ERNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| EpisodeOfCare.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | ||||
| EpisodeOfCare.type | extensible | MREpisodeTypehttps://fhir.medirecords.com/ValueSet/mr-episode-typefrom this IG | ||||
| EpisodeOfCare.diagnosis.condition.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard | ||||
| EpisodeOfCare.careManager.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| EpisodeOfCare.team.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ctm-1 | error | EpisodeOfCare.contained:careteam.participant | CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner : onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists())) | |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | 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 | EpisodeOfCare | 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 | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | EpisodeOfCare | 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() | |
| inv-mr-meta-security-01 | error | EpisodeOfCare.meta.security | Medirecords supports only U, R security code : code.exists() implies (code = 'U' or code = 'R') |