minimal Common Oncology Data Elements (mCODE) Implementation Guide, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-mCODE-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-patient-group | Version: 4.0.0-ballot | |||
Active as of 2024-10-30 | Maturity Level: 1 | Computable Name: MCODEPatientGroup | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.15.42.39 |
A group of patients included in the scope of mCODE, whose cancer-related resources conform to mCODE profiles.
This profile is used to return a list of all mCODE patients when a mCODE Data Sender identifies mCODE patients using the Patients-in-Group Approach. Use of this profile is explained in greater detail in the conformance discussion.
Usage:
Changes since version true:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | 0..* | Group | Group of multiple entities | |
code | 0..1 | CodeableConcept | Kind of Group members Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C19700 | |
member | ||||
entity | 1..1 | Reference(Cancer Patient Profile) | Reference to the group member | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. |
actual | ΣC | 1..1 | boolean | Descriptive or actual |
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C19700 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | |
Group.code | example | Pattern: C19700 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique id | ||||
active | Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
actual | ΣC | 1..1 | boolean | Descriptive or actual | ||||
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C19700 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | Σ | 0..1 | string | Label for Group | ||||
quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
characteristic | 0..* | BackboneElement | Include / Exclude group members by Trait | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Kind of characteristic Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
value[x] | 1..1 | Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(Any) | |||||||
exclude | 1..1 | boolean | Group includes or excludes | |||||
period | 0..1 | Period | Period over which characteristic is tested | |||||
member | C | 0..* | BackboneElement | Who or what is in group | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity | 1..1 | Reference(Cancer Patient Profile) | Reference to the group member | |||||
period | 0..1 | Period | Period member belonged to the group | |||||
inactive | 0..1 | boolean | If member is no longer in group | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | ||||
Group.code | example | Pattern: C19700 | ||||
Group.characteristic.code | example | |||||
Group.characteristic.value[x] | example |
Differential View
This structure is derived from Group
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | 0..* | Group | Group of multiple entities | |
code | 0..1 | CodeableConcept | Kind of Group members Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C19700 | |
member | ||||
entity | 1..1 | Reference(Cancer Patient Profile) | Reference to the group member | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. |
actual | ΣC | 1..1 | boolean | Descriptive or actual |
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C19700 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | |
Group.code | example | Pattern: C19700 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Group | C | 0..* | Group | Group of multiple entities grp-1: Can only have members if group is "actual" | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique id | ||||
active | Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. | ||||
actual | ΣC | 1..1 | boolean | Descriptive or actual | ||||
code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C19700 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
name | Σ | 0..1 | string | Label for Group | ||||
quantity | Σ | 0..1 | unsignedInt | Number of members | ||||
managingEntity | Σ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | Entity that is the custodian of the Group's definition | ||||
characteristic | 0..* | BackboneElement | Include / Exclude group members by Trait | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | Kind of characteristic Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
value[x] | 1..1 | Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(Any) | |||||||
exclude | 1..1 | boolean | Group includes or excludes | |||||
period | 0..1 | Period | Period over which characteristic is tested | |||||
member | C | 0..* | BackboneElement | Who or what is in group | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
entity | 1..1 | Reference(Cancer Patient Profile) | Reference to the group member | |||||
period | 0..1 | Period | Period member belonged to the group | |||||
inactive | 0..1 | boolean | If member is no longer in group | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Group.type | required | GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard | ||||
Group.code | example | Pattern: C19700 | ||||
Group.characteristic.code | example | |||||
Group.characteristic.value[x] | example |
Other representations of profile: CSV, Excel, Schematron