Genomics Clinical Picture Repository Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: Genomics Clinical Picture Repository Research Subject
| Official URL: http://aehrc.github.io/genclipr-fhir-ig/StructureDefinition/GencliprResearchSubject | Version: 0.1.0 | |||
| Active as of 2022-03-21 | Computable Name: GencliprResearchSubject | |||
Copyright/Legal: Australian Genomics |
||||
This resource represents a patient that is the subject of a research study.
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ResearchSubject
This structure is derived from ResearchSubject
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ResearchSubject | 0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |
  identifier | S | 1..* | Identifier | Business Identifier for research subject in a study |
  type | 0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
 study | S | 1..1 | Reference(Genomics Clinical Picture Repository Research Study) | Study subject is part of |
| individual | S | 1..1 | Reference(Deidentified Patient) | Who is part of study |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ResearchSubject | 0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | SΣ | 1..* | Identifier | Business Identifier for research subject in a study |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn Binding: ResearchSubjectStatus (required): Indicates the progression of a study subject through a study. |
| period | Σ | 0..1 | Period | Start and end of participation |
| study | SΣ | 1..1 | Reference(Genomics Clinical Picture Repository Research Study) | Study subject is part of |
| individual | SΣ | 1..1 | Reference(Deidentified Patient) | Who is part of study |
| assignedArm | 0..1 | string | What path should be followed | |
| actualArm | 0..1 | string | What path was followed | |
| consent | 0..1 | Reference(Consent) | Agreement to participate in study | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ResearchSubject | 0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |
| identifier | Σ | 1..* | Identifier | Business Identifier for research subject in a study |
| study | Σ | 1..1 | Reference(Genomics Clinical Picture Repository Research Study) | Study subject is part of |
| individual | Σ | 1..1 | Reference(Deidentified Patient) | Who is part of study |
| Documentation for this format | ||||
This structure is derived from ResearchSubject
Differential View
This structure is derived from ResearchSubject
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ResearchSubject | 0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |
| identifier | S | 1..* | Identifier | Business Identifier for research subject in a study |
| type | 0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| study | S | 1..1 | Reference(Genomics Clinical Picture Repository Research Study) | Study subject is part of |
| individual | S | 1..1 | Reference(Deidentified Patient) | Who is part of study |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ResearchSubject | 0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | SΣ | 1..* | Identifier | Business Identifier for research subject in a study |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn Binding: ResearchSubjectStatus (required): Indicates the progression of a study subject through a study. |
| period | Σ | 0..1 | Period | Start and end of participation |
| study | SΣ | 1..1 | Reference(Genomics Clinical Picture Repository Research Study) | Study subject is part of |
| individual | SΣ | 1..1 | Reference(Deidentified Patient) | Who is part of study |
| assignedArm | 0..1 | string | What path should be followed | |
| actualArm | 0..1 | string | What path was followed | |
| consent | 0..1 | Reference(Consent) | Agreement to participate in study | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| ResearchSubject.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ResearchSubject.identifier.use | required | IdentifierUse |
| ResearchSubject.identifier.type | extensible | Pattern: PI |
| ResearchSubject.status | required | ResearchSubjectStatus |
Constraints
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | ResearchSubject | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ResearchSubject | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ResearchSubject | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ResearchSubject | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | ResearchSubject | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | ResearchSubject.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ResearchSubject.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ResearchSubject.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ResearchSubject.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ResearchSubject.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ResearchSubject.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ResearchSubject.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.study | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.individual | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.assignedArm | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.actualArm | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ResearchSubject.consent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |