Te Whatu Ora Shared Care FHIR API
0.3.9 - release
Te Whatu Ora Shared Care FHIR API - Local Development build (v0.3.9) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir-ig-uat.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-rheumaticfever-careteam | Version: 1.0.0 | |||
Active as of 2024-06-20 | Computable Name: RheumaticFeverCareTeam |
Identifies parties involved in secondary prophylaxis (preventative treatment) for a patient. Members typically comprise rheumatic fever service Organizations and Practitioners especially nurses
Controls CareTeam representations to model care teams involved in rheumatic fever secondary prophylaxis (preventative treatment)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CareTeam
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
Slices for identifier | 0..* | Identifier | External Ids for this team Slice: Unordered, Open by value:use | |
identifier:NationalSystem | 0..* | Identifier | This allows a rheumatic fever patient resource to link with corresponding objects in systems like salesforce | |
id | 0..0 | |||
extension | 0..0 | |||
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
type | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | |
system | 0..1 | uri | The namespace for the identifier value Example General: Uri that defines the type of external identifier | |
value | 1..1 | string | The value that is unique Example Salesforce object id: CTM-0000144 | |
category | 1..1 | CodeableConcept | Type of team Binding: Rheumatic fever care team category codes (required) 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://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 320741000210108 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Secondary prophylaxis team | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CareTeam.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/external-system-identifier-type-code from this IG | |
CareTeam.category | required | Pattern: SNOMED-CT Code 320741000210108("Secondary prophylaxis team")https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/rf-careteam-category-code from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | External Ids for this team Slice: Unordered, Open by value:use |
identifier:NationalSystem | Σ | 0..* | Identifier | This allows a rheumatic fever patient resource to link with corresponding objects in systems like salesforce |
extension | 0..0 | |||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example General: Uri that defines the type of external identifier |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Salesforce object id: CTM-0000144 |
status | ?!Σ | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. |
category | Σ | 1..1 | CodeableConcept | Type of team Binding: Rheumatic fever care team category codes (required) 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://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 320741000210108 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Secondary prophylaxis team | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CareTeam.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
CareTeam.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/external-system-identifier-type-code from this IG | |
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | |
CareTeam.category | required | Pattern: SNOMED-CT Code 320741000210108("Secondary prophylaxis team")https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/rf-careteam-category-code from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |||||
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 | ||||
Slices for identifier | Σ | 0..* | Identifier | External Ids for this team Slice: Unordered, Open by value:use | ||||
identifier:NationalSystem | Σ | 0..* | Identifier | This allows a rheumatic fever patient resource to link with corresponding objects in systems like salesforce | ||||
extension | 0..0 | |||||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example General: Uri that defines the type of external identifier | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Salesforce object id: CTM-0000144 | ||||
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 | ?!Σ | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
category | Σ | 1..1 | CodeableConcept | Type of team Binding: Rheumatic fever care team category codes (required) 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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 320741000210108 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Secondary prophylaxis team | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | ||||
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 | Σ | 0..* | Reference(Organization) | Organization responsible for the care team | ||||
telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
note | 0..* | Annotation | Comments made about the CareTeam | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CareTeam.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CareTeam.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CareTeam.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/external-system-identifier-type-code from this IG | ||||
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | ||||
CareTeam.category | required | Pattern: SNOMED-CT Code 320741000210108("Secondary prophylaxis team")https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/rf-careteam-category-code from this IG | ||||
CareTeam.participant.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
CareTeam.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
Differential View
This structure is derived from CareTeam
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
Slices for identifier | 0..* | Identifier | External Ids for this team Slice: Unordered, Open by value:use | |
identifier:NationalSystem | 0..* | Identifier | This allows a rheumatic fever patient resource to link with corresponding objects in systems like salesforce | |
id | 0..0 | |||
extension | 0..0 | |||
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
type | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | |
system | 0..1 | uri | The namespace for the identifier value Example General: Uri that defines the type of external identifier | |
value | 1..1 | string | The value that is unique Example Salesforce object id: CTM-0000144 | |
category | 1..1 | CodeableConcept | Type of team Binding: Rheumatic fever care team category codes (required) 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://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 320741000210108 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Secondary prophylaxis team | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CareTeam.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/external-system-identifier-type-code from this IG | |
CareTeam.category | required | Pattern: SNOMED-CT Code 320741000210108("Secondary prophylaxis team")https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/rf-careteam-category-code from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | External Ids for this team Slice: Unordered, Open by value:use |
identifier:NationalSystem | Σ | 0..* | Identifier | This allows a rheumatic fever patient resource to link with corresponding objects in systems like salesforce |
extension | 0..0 | |||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example General: Uri that defines the type of external identifier |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Salesforce object id: CTM-0000144 |
status | ?!Σ | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. |
category | Σ | 1..1 | CodeableConcept | Type of team Binding: Rheumatic fever care team category codes (required) 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://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 320741000210108 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Secondary prophylaxis team | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CareTeam.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
CareTeam.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/external-system-identifier-type-code from this IG | |
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | |
CareTeam.category | required | Pattern: SNOMED-CT Code 320741000210108("Secondary prophylaxis team")https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/rf-careteam-category-code from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |||||
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 | ||||
Slices for identifier | Σ | 0..* | Identifier | External Ids for this team Slice: Unordered, Open by value:use | ||||
identifier:NationalSystem | Σ | 0..* | Identifier | This allows a rheumatic fever patient resource to link with corresponding objects in systems like salesforce | ||||
extension | 0..0 | |||||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example General: Uri that defines the type of external identifier | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Salesforce object id: CTM-0000144 | ||||
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 | ?!Σ | 0..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
category | Σ | 1..1 | CodeableConcept | Type of team Binding: Rheumatic fever care team category codes (required) 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://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 320741000210108 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Secondary prophylaxis team | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
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 | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) | Who is involved | ||||
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 | Σ | 0..* | Reference(Organization) | Organization responsible for the care team | ||||
telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
note | 0..* | Annotation | Comments made about the CareTeam | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CareTeam.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CareTeam.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CareTeam.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/external-system-identifier-type-code from this IG | ||||
CareTeam.status | required | CareTeamStatushttp://hl7.org/fhir/ValueSet/care-team-status|4.0.1 from the FHIR Standard | ||||
CareTeam.category | required | Pattern: SNOMED-CT Code 320741000210108("Secondary prophylaxis team")https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/rf-careteam-category-code from this IG | ||||
CareTeam.participant.role | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
CareTeam.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
Other representations of profile: CSV, Excel, Schematron