CodeX Implementation Guide: ICAREdata v0.1.2

CodeX Implementation Guide: ICAREdata v0.1.2 FHIR Profiles - Local Development build (v0.1.2). See the Directory of published versions

ResearchSubject

 

The official URL for this profile is:

http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ResearchSubject

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

This profile builds on Basic.

This profile was published on Wed Nov 06 00:00:00 CST 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:

obf.ResearchSubject maps to Basic:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σobf-ResearchSubject
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
... extension 4..*Slice: Unordered, Open by value:url
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
.... valueCodeableConcept Binding: research-subject-status (required)
... obf-datatype-Identifier-extension 0..1IdentifierIdentifier
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-datatype-Identifier-extension
... obf-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ParticipationPeriod-extension
... obf-ResearchStudy-extension 1..1Reference(Basic)ResearchStudy
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ResearchStudy-extension
... obf-Patient-extension 1..1Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-patient)Patient
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Patient-extension
... obf-AssignedArm-extension 0..1stringAssignedArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-AssignedArm-extension
... obf-ActualArm-extension 0..1stringActualArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ActualArm-extension
... obf-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-TerminationReason-extension
.... valueCodeableConcept Binding: ResearchSubjectTerminationReasonVS (required)
... code Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://mcodeinitiative.org/codex/us/icare/CodeSystem/icare-basic-resource-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: obf-ResearchSubject
..... userSelected1..1booleanIf this coding was chosen directly by the user
Fixed Value: false

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σ0..*obf-ResearchSubject
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... 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
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: research-subject-status (required)
... obf-datatype-Identifier-extension 0..1IdentifierIdentifier
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-datatype-Identifier-extension
... obf-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ParticipationPeriod-extension
... obf-ResearchStudy-extension 1..1Reference(Basic)ResearchStudy
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ResearchStudy-extension
... obf-Patient-extension 1..1Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-patient)Patient
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Patient-extension
... obf-AssignedArm-extension 0..1stringAssignedArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-AssignedArm-extension
... obf-ActualArm-extension 0..1stringActualArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ActualArm-extension
... obf-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-TerminationReason-extension
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-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: At least the following
.... id0..1stringxml:id (or equivalent in JSON)
.... extension0..*ExtensionAdditional Content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringxml:id (or equivalent in JSON)
..... extension0..*ExtensionAdditional Content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://mcodeinitiative.org/codex/us/icare/CodeSystem/icare-basic-resource-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: obf-ResearchSubject
..... display0..1stringRepresentation defined by the system
..... userSelected1..1booleanIf this coding was chosen directly by the user
Fixed Value: false
.... text0..1stringPlain text representation of the concept
... 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:

obf.ResearchSubject maps to Basic:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σobf-ResearchSubject
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
... extension 4..*Slice: Unordered, Open by value:url
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
.... valueCodeableConcept Binding: research-subject-status (required)
... obf-datatype-Identifier-extension 0..1IdentifierIdentifier
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-datatype-Identifier-extension
... obf-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ParticipationPeriod-extension
... obf-ResearchStudy-extension 1..1Reference(Basic)ResearchStudy
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ResearchStudy-extension
... obf-Patient-extension 1..1Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-patient)Patient
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Patient-extension
... obf-AssignedArm-extension 0..1stringAssignedArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-AssignedArm-extension
... obf-ActualArm-extension 0..1stringActualArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ActualArm-extension
... obf-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-TerminationReason-extension
.... valueCodeableConcept Binding: ResearchSubjectTerminationReasonVS (required)
... code Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://mcodeinitiative.org/codex/us/icare/CodeSystem/icare-basic-resource-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: obf-ResearchSubject
..... userSelected1..1booleanIf this coding was chosen directly by the user
Fixed Value: false

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic Σ0..*obf-ResearchSubject
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... 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
... obf-Status-extension 1..1CodeableConceptStatus
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: research-subject-status (required)
... obf-datatype-Identifier-extension 0..1IdentifierIdentifier
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-datatype-Identifier-extension
... obf-ParticipationPeriod-extension 1..1PeriodParticipationPeriod
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ParticipationPeriod-extension
... obf-ResearchStudy-extension 1..1Reference(Basic)ResearchStudy
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ResearchStudy-extension
... obf-Patient-extension 1..1Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-patient)Patient
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-Patient-extension
... obf-AssignedArm-extension 0..1stringAssignedArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-AssignedArm-extension
... obf-ActualArm-extension 0..1stringActualArm
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-ActualArm-extension
... obf-TerminationReason-extension 0..1CodeableConceptTerminationReason
URL: http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-TerminationReason-extension
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"http://mcodeinitiative.org/codex/us/icare/StructureDefinition/obf-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: At least the following
.... id0..1stringxml:id (or equivalent in JSON)
.... extension0..*ExtensionAdditional Content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringxml:id (or equivalent in JSON)
..... extension0..*ExtensionAdditional Content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://mcodeinitiative.org/codex/us/icare/CodeSystem/icare-basic-resource-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: obf-ResearchSubject
..... display0..1stringRepresentation defined by the system
..... userSelected1..1booleanIf this coding was chosen directly by the user
Fixed Value: false
.... text0..1stringPlain text representation of the concept
... 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

 

Terminology Bindings

PathConformanceValueSet / Code
Basic.meta.securityextensibleAll Security Labels
Basic.meta.tagexample
Basic.languagerequiredhttp://tools.ietf.org/html/bcp47
Basic.extension-status.valueCodeableConceptrequiredhttp://hl7.org/fhir/ValueSet/research-subject-status
Basic.extension-terminationreason.valueCodeableConceptrequiredResearchSubjectTerminationReasonVS
Basic.codeexamplePattern: obf-ResearchSubject

 

Constraints

IdPathDetailsRequirements