CareTeam
| Canonical URL | https://fhir.synapxe.sg/StructureDefinition/profile-careteam |
|---|---|
| Version | 1.2.0 |
| Status | Active |
| Description | This resource will be used to store the care team details. |
| CareTeam | C | CareTeam | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| extension | C | 0..* | Extension |
| enrollment | C | 0..1 | Extension(string) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| status | Σ ?! | 1..1 | codeBinding |
| category | Σ | 1..1 | CodeableConceptBinding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | code |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| name | Σ | 0..0 | string |
| subject | Σ C | 1..1 | Reference(Patient) |
| period | Σ C | 0..1 | Period |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| start | Σ C | 1..1 | dateTime |
| end | Σ C | 1..1 | dateTime |
| participant | C | 0..* | BackboneElement |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| role | Σ C | 0..0 | CodeableConcept |
| member | Σ C | 1..1 | Reference(PractitionerRole) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..0 | uriBinding |
| identifier | Σ C | 0..0 | Identifier |
| display | Σ C | 0..0 | string |
| onBehalfOf | Σ C | 0..0 | Reference(Organization) |
| coverage[x] | 0..0 | ||
| reason | 0..* | CodeableReference(Condition) | |
| (All Slices) | |||
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| concept | Σ | 1..1 | CodeableConcept |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | code |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| reference | Σ C | 0..0 | Reference |
| reasonForEnrolment | 0..1 | CodeableReference(Condition) | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| concept | Σ | 1..1 | CodeableConcept | CodeableConcept |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..1 | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | codeBinding |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| reference | Σ C | 0..0 | Reference |
| reasonForClosure | 0..1 | CodeableReference(Condition) | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| concept | Σ | 1..1 | CodeableConcept | CodeableConcept |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..1 | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | codeBinding |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| reference | Σ C | 0..0 | Reference |
| managingOrganization | Σ C | 1..1 | Reference(Organization) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| telecom | C | 0..0 | ContactPoint |
| note | 0..* | Annotation | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| author[x] | Σ | 0..0 | |
| time | Σ | 0..0 | dateTime |
| text | Σ | 1..1 | markdown |
| CareTeam | |
| Short | Planned participants in the coordination and delivery of care |
| Definition | The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care. |
| Cardinality | 0..* |
| Constraints |
|
| Mappings |
|
| CareTeam.id | |
| Short | Logical id of this artifact |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Cardinality | 0..1 |
| Type | id |
| Summary | True |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Constraints |
|
| Mappings |
|
| CareTeam.meta | |
| Short | Metadata about the resource |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Cardinality | 0..1 |
| Type | Meta |
| Summary | True |
| Constraints |
|
| Mappings |
|
| CareTeam.implicitRules | |
| Short | A set of rules under which this content was created |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Cardinality | 0..1 |
| Type | uri |
| Modifier | True |
| Summary | True |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
| Constraints |
|
| Mappings |
|
| CareTeam.language | |
| Short | Language of the resource content |
| Definition | The base language in which the resource is written. |
| Cardinality | 0..1 |
| Type | code |
| Binding | IETF language tag for a human language |
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
| Constraints |
|
| Mappings |
|
| CareTeam.text | |
| Short | Text summary of the resource, for human interpretation |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Cardinality | 0..1 |
| Type | Narrative |
| Alias | narrative, html, xhtml, display |
| Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-6 |
| Constraints |
|
| Mappings |
|
| CareTeam.contained | |
| Short | Contained, inline Resources |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Cardinality | 0..* |
| Type | Resource |
| Alias | inline resources, anonymous resources, contained resources |
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| Mappings |
|
| CareTeam.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..* |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.extension:enrollment | |
| Short | Enrollment Information |
| Definition | Extension for capturing enrollment information in CareTeam |
| Cardinality | 0..1 |
| Type | Extension(string) |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| CareTeam.modifierExtension | |
| Short | Extensions that cannot be ignored |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Requirements | Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers. |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Constraints |
|
| Mappings |
|
| CareTeam.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| CareTeam.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| CareTeam.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/enrolment-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| CareTeam.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| CareTeam.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| CareTeam.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| CareTeam.status | |
| Short | proposed | active | suspended | inactive | entered-in-error |
| Definition | Indicates the current state of the care team. |
| Cardinality | 1..1 |
| Type | code |
| Binding | Indicates the status of the care team. |
| Modifier | True |
| Summary | True |
| Comments | This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid. |
| Constraints |
|
| Examples | Activeactive |
| Mappings |
|
| CareTeam.category | |
| Short | programme name |
| Definition | programme name |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | Indicates the type of care team. |
| Summary | True |
| Requirements | Used for filtering what teams(s) are retrieved and displayed to different types of users. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| CareTeam.category.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.category.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.category.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| CareTeam.category.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.category.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.category.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/CodeSystem/programme-name |
| Mappings |
|
| CareTeam.category.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| CareTeam.category.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Examples | SGH Nurse NavigatorSGHNurseNavigator |
| Mappings |
|
| CareTeam.category.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.category.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| CareTeam.category.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| CareTeam.name | |
| Short | Name of the team, such as crisis assessment team |
| Definition | A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. "Red trauma team"), but its primary purpose is to distinguish between identical teams in a human-friendly way. ("Team 18735" isn't as friendly.). |
| Constraints |
|
| Mappings |
|
| CareTeam.subject | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 1..1 |
| Type | Reference(Patient) |
| Summary | True |
| Alias | patient |
| Requirements | Allows the team to care for a group (e.g. marriage) therapy. Allows for an organization to designate a team such as the PICC line team. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| CareTeam.period | |
| Short | Time period team covers |
| Definition | Indicates when the team did (or is intended to) come into effect and end. |
| Cardinality | 0..1 |
| Type | Period |
| Summary | True |
| Requirements | Allows tracking what team(s) are in effect at a particular time. |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| CareTeam.period.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.period.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.period.start | |
| Short | Starting time with inclusive boundary |
| Definition | The start of the period. The boundary is inclusive. |
| Cardinality | 1..1 |
| Type | dateTime |
| Summary | True |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.period.end | |
| Short | End time with inclusive boundary, if not ongoing |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Cardinality | 1..1 |
| Type | dateTime |
| Summary | True |
| Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Meaning when missing | If the end of the period is missing, it means that the period is ongoing |
| Conditions | The cardinality or value of this element may be affected by these constraints: per-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant | |
| Short | care manager of this patient |
| Definition | care manager of this patient |
| Cardinality | 0..* |
| Type | BackboneElement |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.participant.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.modifierExtension | |
| Short | Extensions that cannot be ignored even if unrecognized |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Cardinality | 0..0 |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role | |
| Short | Type of involvement |
| Definition | Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
| Summary | True |
| Comments | Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly. If a participant has multiple roles within the team, then there should be multiple participants. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ctm-2 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.participant.role.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..1 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.participant.role.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.role.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.member | |
| Short | the care manager for this patient and the organization where the practioner performs the roles associated |
| Definition | the care manager for this patient and the organization where the practioner performs the roles associated |
| Cardinality | 1..1 |
| Type | Reference(PractitionerRole) |
| Summary | True |
| Comments | Patient only needs to be listed if they have a role other than "subject of care". Member is optional because some participants may be known only by their role, particularly in draft plans. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ctm-1, ctm-2 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.member.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.participant.member.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.member.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.member.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 0..0 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.member.identifier | |
| Short | Logical reference, when literal reference is not known |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Cardinality | 0..0 |
| Type | Identifier |
| Summary | True |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.member.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.onBehalfOf | |
| Short | Organization of the practitioner |
| Definition | The organization of the practitioner. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Requirements | Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ctm-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.participant.coverage[x] | |
| Short | When the member is generally available within this care team |
| Definition | When the member is generally available within this care team. |
| Cardinality | 0..0 |
| Type | Period | Timing |
| Requirements | To manage members who share the same role, but with different timing. For example, two physical therapists where one is available Monday through Friday whereas the other is available on the weekend. |
| Comments | This is populated while creating / managing the CareTeam to ensure there is coverage when servicing CarePlan activities from the Schedule. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason | |
| Short | Why the care team exists |
| Definition | Describes why the care team exists. |
| Cardinality | 0..* |
| Type | CodeableReference(Condition) |
| Binding | Indicates the reason for the care team. |
| Slicing | Unordered, Open, by $this(Value) |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Summary | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason.concept.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason.concept.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.concept.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason.reference | |
| Short | Reference to a resource (by instance) |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Cardinality | 0..0 |
| Type | Reference |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment | |
| Short | Reason for the programme enrolment |
| Definition | Reason for the programme enrolment |
| Cardinality | 0..1 |
| Type | CodeableReference(Condition) |
| Binding | Indicates the reason for the care team. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept | CodeableConcept |
| Summary | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..1 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/CodeSystem/reasonForEnrolment |
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Binding | |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.concept.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForEnrolment.reference | |
| Short | Reference to a resource (by instance) |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Cardinality | 0..0 |
| Type | Reference |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure | |
| Short | Why the care team exists |
| Definition | Describes why the care team exists. |
| Cardinality | 0..1 |
| Type | CodeableReference(Condition) |
| Binding | Indicates the reason for the care team. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason:reasonForClosure.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept | CodeableConcept |
| Summary | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..1 |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/CodeSystem/reasonForClosure |
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Binding | |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.concept.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| CareTeam.reason:reasonForClosure.reference | |
| Short | Reference to a resource (by instance) |
| Definition | A reference to a resource the provides exact details about the information being referenced. |
| Cardinality | 0..0 |
| Type | Reference |
| Summary | True |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 1..1 |
| Type | Reference(Organization) |
| Summary | True |
| Requirements | Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.managingOrganization.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.reference | |
| Short | Literal reference, Relative, internal or absolute URL |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Cardinality | 1..1 |
| Type | uri |
| Binding | Aa resource (or, for logical models, the URI of the logical model). |
| Summary | True |
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Organization |
| Mappings |
|
| CareTeam.managingOrganization.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.identifier.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.managingOrganization.identifier.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/hci-code |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| CareTeam.managingOrganization.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| CareTeam.managingOrganization.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| Type | Period |
| Summary | True |
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| CareTeam.managingOrganization.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| CareTeam.telecom | |
| Short | A contact detail for the care team (that applies to all members) |
| Definition | A central contact detail for the care team (that applies to all members). |
| Cardinality | 0..0 |
| Type | ContactPoint |
| Comments | The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members. |
| Constraints |
|
| Mappings |
|
| CareTeam.note | |
| Short | Comments made about the CareTeam |
| Definition | Comments made about the CareTeam. |
| Cardinality | 0..* |
| Type | Annotation |
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
| Constraints |
|
| Mappings |
|
| CareTeam.note.id | |
| Short | Unique id for inter-element referencing |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| CareTeam.note.extension | |
| Short | Additional content defined by implementations |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Cardinality | 0..0 |
| Type | Extension |
| Alias | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| CareTeam.note.author[x] | |
| Short | Individual responsible for the annotation |
| Definition | The individual responsible for making the annotation. |
| Cardinality | 0..0 |
| Type | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | string |
| Summary | True |
| Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
| Constraints |
|
| Mappings |
|
| CareTeam.note.time | |
| Short | When the annotation was made |
| Definition | Indicates when this particular annotation was made. |
| Cardinality | 0..0 |
| Type | dateTime |
| Summary | True |
| Comments | UTC offset is allowed for dates and partial dates |
| Constraints |
|
| Mappings |
|
| CareTeam.note.text | |
| Short | The annotation - text content (as markdown) |
| Definition | The text of the annotation in markdown format. |
| Cardinality | 1..1 |
| Type | markdown |
| Summary | True |
| Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ |
| Constraints |
|
| Mappings |
|
Terminology Bindings
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| CareTeam.language | required | http://hl7.org/fhir/ValueSet/all-languages|5.0.0 | IETF language tag for a human language |
| CareTeam.status | required | http://hl7.org/fhir/ValueSet/care-team-status|5.0.0 | Indicates the status of the care team. |
| CareTeam.category | required | https://fhir.synapxe.sg/ValueSet/programme-name | Indicates the type of care team. |
| CareTeam.reason | example | http://hl7.org/fhir/ValueSet/clinical-findings | Indicates the reason for the care team. |
| CareTeam.reason | example | http://hl7.org/fhir/ValueSet/clinical-findings | Indicates the reason for the care team. |
| CareTeam.reason.concept.coding.code | required | https://fhir.synapxe.sg/ValueSet/reasonForEnrolment | |
| CareTeam.reason | example | http://hl7.org/fhir/ValueSet/clinical-findings | Indicates the reason for the care team. |
| CareTeam.reason.concept.coding.code | required | https://fhir.synapxe.sg/ValueSet/reasonForClosure | |
| CareTeam.managingOrganization.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |