HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

Publish Box goes here

ResearchSubject

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ResearchSubject

Record of a subject's enrollment and participation in a research study.

This profile builds on Basic.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (4 nested mandatory elements)

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.ResearchSubject maps to Basic:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σshr-core-ResearchSubject
... extension 4..*Slice: Unordered, Open by value:url
... shr-core-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... valueCodeableConcept Binding: research-subject-status (required)
... shr-core-Identifier-extension 0..1IdentifierIdentifier
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Identifier-extension
... shr-core-Patient-extension 1..1Reference(shr-core-Patient)Patient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Patient-extension
... shr-core-ResearchStudy-extension 1..1Reference(shr-core-ResearchStudy)ResearchStudy
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ResearchStudy-extension
... shr-core-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ParticipationPeriod-extension
... shr-core-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TerminationReason-extension
.... valueCodeableConcept Binding: ResearchSubjectTerminationReasonVS (required)
... code Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/shr/CodeSystem/mcode-basic-resource-type","code":"shr-core-ResearchSubject","userSelected":false}]}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σ0..*shr-core-ResearchSubject
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 4..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: research-subject-status (required)
... shr-core-Identifier-extension 0..1IdentifierIdentifier
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Identifier-extension
... shr-core-Patient-extension 1..1Reference(shr-core-Patient)Patient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Patient-extension
... shr-core-ResearchStudy-extension 1..1Reference(shr-core-ResearchStudy)ResearchStudy
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ResearchStudy-extension
... shr-core-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ParticipationPeriod-extension
... shr-core-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TerminationReason-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TerminationReason-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: ResearchSubjectTerminationReasonVS (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/shr/CodeSystem/mcode-basic-resource-type","code":"shr-core-ResearchSubject","userSelected":false}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... author Σ0..1Reference(Practitioner | Patient | RelatedPerson)Who created
... created Σ0..1dateWhen created

doco Documentation for this format

Summary

Mandatory: 0 element (4 nested mandatory elements)

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.ResearchSubject maps to Basic:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σshr-core-ResearchSubject
... extension 4..*Slice: Unordered, Open by value:url
... shr-core-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... valueCodeableConcept Binding: research-subject-status (required)
... shr-core-Identifier-extension 0..1IdentifierIdentifier
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Identifier-extension
... shr-core-Patient-extension 1..1Reference(shr-core-Patient)Patient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Patient-extension
... shr-core-ResearchStudy-extension 1..1Reference(shr-core-ResearchStudy)ResearchStudy
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ResearchStudy-extension
... shr-core-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ParticipationPeriod-extension
... shr-core-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TerminationReason-extension
.... valueCodeableConcept Binding: ResearchSubjectTerminationReasonVS (required)
... code Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/shr/CodeSystem/mcode-basic-resource-type","code":"shr-core-ResearchSubject","userSelected":false}]}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σ0..*shr-core-ResearchSubject
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 4..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Status-extension 1..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: research-subject-status (required)
... shr-core-Identifier-extension 0..1IdentifierIdentifier
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Identifier-extension
... shr-core-Patient-extension 1..1Reference(shr-core-Patient)Patient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Patient-extension
... shr-core-ResearchStudy-extension 1..1Reference(shr-core-ResearchStudy)ResearchStudy
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ResearchStudy-extension
... shr-core-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ParticipationPeriod-extension
... shr-core-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TerminationReason-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TerminationReason-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: ResearchSubjectTerminationReasonVS (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/shr/CodeSystem/mcode-basic-resource-type","code":"shr-core-ResearchSubject","userSelected":false}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... author Σ0..1Reference(Practitioner | Patient | RelatedPerson)Who created
... created Σ0..1dateWhen created

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

 

Constraints

IdPathDetailsRequirements