Standard Health Record FHIR Implementation Guide

SHR ResearchSubject Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-research-ResearchSubject

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

This profile builds on ResearchSubject.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.research.ResearchSubject maps to ResearchSubject:
  Patient maps to individual
  Study maps to study
  Status maps to status
  ParticipationPeriod maps to period

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchSubject I0..*SHR ResearchSubject Profile
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-research-TerminationReason-extension 0..1CodeableConceptSHR TerminationReason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-research-TerminationReason-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-research-TerminationReason-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR ResearchSubjectTerminationReasonVS ValueSet (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierBusiness Identifier for research subject
... status ?!Σ1..1codecandidate | enrolled | active | suspended | withdrawn | completed
Binding: ResearchSubjectStatus (required)
... period Σ1..1PeriodStart and end of participation
... study Σ1..1Reference(SHR Study Profile)Study subject is part of
... individual Σ1..1Reference(SHR Patient Profile)Who is part of study
... assignedArm 0..1stringWhat path should be followed
... actualArm 0..1stringWhat path was followed
... consent 0..1Reference(Consent)Agreement to participate in study

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.research.ResearchSubject maps to ResearchSubject:
  Patient maps to individual
  Study maps to study
  Status maps to status
  ParticipationPeriod maps to period

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchSubject I0..*SHR ResearchSubject Profile
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-research-TerminationReason-extension 0..1CodeableConceptSHR TerminationReason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-research-TerminationReason-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-research-TerminationReason-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR ResearchSubjectTerminationReasonVS ValueSet (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierBusiness Identifier for research subject
... status ?!Σ1..1codecandidate | enrolled | active | suspended | withdrawn | completed
Binding: ResearchSubjectStatus (required)
... period Σ1..1PeriodStart and end of participation
... study Σ1..1Reference(SHR Study Profile)Study subject is part of
... individual Σ1..1Reference(SHR Patient Profile)Who is part of study
... assignedArm 0..1stringWhat path should be followed
... actualArm 0..1stringWhat path was followed
... consent 0..1Reference(Consent)Agreement to participate in study

doco Documentation for this format

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

 

Terminology Bindings

PathNameConformanceValueSet
ResearchSubject.languageCommon LanguagesextensibleCommon Languages
ResearchSubject.extension.valueCodeableConceptSHR ResearchSubjectTerminationReasonVS ValueSetrequiredSHR ResearchSubjectTerminationReasonVS ValueSet
ResearchSubject.statusResearchSubjectStatusrequiredResearchSubjectStatus

 

Constraints

IdPathDetailsRequirements
dom-2ResearchSubjectIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ResearchSubjectIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ResearchSubjectIf 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-3ResearchSubjectIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()