MII_IG_Person - Local Development build (v2025.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://www.medizininformatik-initiative.de/fhir/core/modul-person/StructureDefinition/ResearchSubject | Version: 2025.0.1 | |||
| Retired as of 2024-11-11 | Computable Name: MII_PR_Person_Proband | |||
Dieses Profil beschreibt eine Proband*in in der Medizininformatik-Initiative.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣ | 1..* | Identifier | Business Identifier for research subject in a study Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Business Identifier for research subject in a study ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ANON | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() |
?!SΣ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣC | 1..1 | Period | Start and end of participation ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣC | 1..1 | Reference(ResearchStudy) | Study subject is part of ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who is part of study ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() |
SC | 1..1 | Reference(Consent) | Agreement to participate in study ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ResearchSubject.identifier:subjectIdentificationCode.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ResearchSubject.identifier:subjectIdentificationCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ResearchSubject.status | required | ResearchSubjectStatushttp://hl7.org/fhir/ValueSet/research-subject-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | ResearchSubject.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | ResearchSubject.study, ResearchSubject.individual, ResearchSubject.consent | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from ResearchSubject
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() |
S | 1..* | Identifier | Business Identifier for research subject in a study Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() |
S | 1..1 | Identifier | Business Identifier for research subject in a study Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ANON | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 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 |
![]() ![]() |
S | 1..1 | Period | Start and end of participation |
![]() ![]() ![]() |
S | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() |
S | 1..1 | Reference(ResearchStudy) | Study subject is part of |
![]() ![]() |
S | 1..1 | Reference(Patient) | Who is part of study |
![]() ![]() |
S | 1..1 | Reference(Consent) | Agreement to participate in study |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |||||
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business Identifier for research subject in a study Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Business Identifier for research subject in a study Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ANON | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
?!SΣ | 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. | ||||
![]() ![]() |
SΣC | 1..1 | Period | Start and end of participation per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
SΣC | 1..1 | Reference(ResearchStudy) | Study subject is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who is part of study ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
0..1 | string | What path should be followed | |||||
![]() ![]() |
0..1 | string | What path was followed | |||||
![]() ![]() |
SC | 1..1 | Reference(Consent) | Agreement to participate in study ref-1: SHALL have a contained resource if a local reference is provided | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ResearchSubject.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| ResearchSubject.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| ResearchSubject.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ResearchSubject.identifier:subjectIdentificationCode.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ResearchSubject.identifier:subjectIdentificationCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ResearchSubject.status | required | ResearchSubjectStatushttp://hl7.org/fhir/ValueSet/research-subject-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | ResearchSubject.identifier:subjectIdentificationCode.period, ResearchSubject.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | ResearchSubject.identifier:subjectIdentificationCode.assigner, ResearchSubject.study, ResearchSubject.individual, ResearchSubject.consent | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from ResearchSubject
Summary
Mandatory: 7 elements
Must-Support: 15 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣ | 1..* | Identifier | Business Identifier for research subject in a study Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Business Identifier for research subject in a study ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ANON | |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() |
?!SΣ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣC | 1..1 | Period | Start and end of participation ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣC | 1..1 | Reference(ResearchStudy) | Study subject is part of ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who is part of study ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() |
SC | 1..1 | Reference(Consent) | Agreement to participate in study ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ResearchSubject.identifier:subjectIdentificationCode.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ResearchSubject.identifier:subjectIdentificationCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ResearchSubject.status | required | ResearchSubjectStatushttp://hl7.org/fhir/ValueSet/research-subject-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | ResearchSubject.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | ResearchSubject.study, ResearchSubject.individual, ResearchSubject.consent | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Differential View
This structure is derived from ResearchSubject
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() |
S | 1..* | Identifier | Business Identifier for research subject in a study Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() |
S | 1..1 | Identifier | Business Identifier for research subject in a study Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ANON | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() |
S | 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 |
![]() ![]() |
S | 1..1 | Period | Start and end of participation |
![]() ![]() ![]() |
S | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() |
S | 1..1 | Reference(ResearchStudy) | Study subject is part of |
![]() ![]() |
S | 1..1 | Reference(Patient) | Who is part of study |
![]() ![]() |
S | 1..1 | Reference(Consent) | Agreement to participate in study |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ResearchSubject | Physical entity which is the primary unit of interest in the study | |||||
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business Identifier for research subject in a study Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Business Identifier for research subject in a study Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ANON | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
?!SΣ | 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. | ||||
![]() ![]() |
SΣC | 1..1 | Period | Start and end of participation per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
SΣC | 1..1 | Reference(ResearchStudy) | Study subject is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Who is part of study ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
0..1 | string | What path should be followed | |||||
![]() ![]() |
0..1 | string | What path was followed | |||||
![]() ![]() |
SC | 1..1 | Reference(Consent) | Agreement to participate in study ref-1: SHALL have a contained resource if a local reference is provided | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ResearchSubject.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| ResearchSubject.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| ResearchSubject.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ResearchSubject.identifier:subjectIdentificationCode.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ResearchSubject.identifier:subjectIdentificationCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ResearchSubject.status | required | ResearchSubjectStatushttp://hl7.org/fhir/ValueSet/research-subject-status|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | ResearchSubject.identifier:subjectIdentificationCode.period, ResearchSubject.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | ResearchSubject.identifier:subjectIdentificationCode.assigner, ResearchSubject.study, ResearchSubject.individual, ResearchSubject.consent | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from ResearchSubject
Summary
Mandatory: 7 elements
Must-Support: 15 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron