ICHOM FHIR Implementation Guide: Breast Cancer
1.0.0-ballot - ballot International flag

This page is part of the ICHOM FHIR Implementation Guide: Breast Cancer (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Example Bundle: Bundle the clinical response at baseline

Bundle DebugBundleClinical-01-Baseline of type transaction


Entry 1

Request:

PUT ValueSet/LateralityVS

Resource ValueSet:


Entry 2

Request:

PUT ValueSet/NoYesUnknownVS

Resource ValueSet:


Entry 3

Request:

PUT ValueSet/LateralityNewCancerVS

Resource ValueSet:


Entry 4

Request:

PUT ValueSet/HistologicalTypeVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    399935008Ductal carcinoma in situ - category
    373395001Invasive ductal carcinoma with an extensive intraductal component
    722524005Primary invasive pleomorphic lobular carcinoma of breast
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    OTHother**Description:**The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system).

    **Usage Notes**: This flavor and its specializations are most commonly used with the CD datatype and its flavors. However, it may apply to \*any\* datatype where the constraints of the type are tighter than can be conveyed. For example, a PQ that is for a true measured amount whose units are not supported in UCUM, a need to convey a REAL when the type has been constrained to INT, etc.

    With coded datatypes, this null flavor may only be used if the vocabulary binding has a coding strength of CNE. By definition, all local codes and original text are part of the value set if the coding strength is CWE.
    UNKunknown**Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)


Entry 5

Request:

PUT ValueSet/GermlineMutationVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    445180002Breast cancer genetic marker of susceptibility negative (finding)
    412734009BRCA1 gene mutation positive (finding)
    412738007BRCA2 gene mutation positive (finding)
    416237000Procedure not done
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    OTHother**Description:**The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system).

    **Usage Notes**: This flavor and its specializations are most commonly used with the CD datatype and its flavors. However, it may apply to \*any\* datatype where the constraints of the type are tighter than can be conveyed. For example, a PQ that is for a true measured amount whose units are not supported in UCUM, a need to convey a REAL when the type has been constrained to INT, etc.

    With coded datatypes, this null flavor may only be used if the vocabulary binding has a coding strength of CNE. By definition, all local codes and original text are part of the value set if the coding strength is CWE.


Entry 6

Request:

PUT ValueSet/GradingVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    399415002Low grade histologic differentiation (finding)
    405986005Intermediate grade histologic differentiation (finding)
    399611001High grade histologic differentiation (finding)
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    NINo information**Description:**The value is exceptional (missing, omitted, incomplete, improper). No information as to the reason for being an exceptional value is provided. This is the most general exceptional value. It is also the default exceptional value.


Entry 7

Request:

PUT ValueSet/TNMPrimaryTumorVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    1222604002American Joint Committee on Cancer cTX
    1228882005American Joint Committee on Cancer cT0
    1228885007American Joint Committee on Cancer cTis(DCIS)
    1228888009American Joint Committee on Cancer cTis(Paget)
    1228889001American Joint Committee on Cancer cT1
    1228929004American Joint Committee on Cancer cT2
    1228938002American Joint Committee on Cancer cT3
    1228944003American Joint Committee on Cancer cT4
    1228950008American Joint Committee on Cancer pTX
    1228951007American Joint Committee on Cancer pT0
    1228954004American Joint Committee on Cancer pTis(DCIS)
    1228956002American Joint Committee on Cancer pTis(Paget)
    1228957006American Joint Committee on Cancer pT1
    1229852009American Joint Committee on Cancer pT2
    1229859000American Joint Committee on Cancer pT3
    1229864001American Joint Committee on Cancer pT4
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    UNKunknown**Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)


Entry 8

Request:

PUT ValueSet/TNMRegionalNodesVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    1229966003American Joint Committee on Cancer cNX
    1229967007American Joint Committee on Cancer cN0
    1229973008American Joint Committee on Cancer cN1
    1229978004American Joint Committee on Cancer cN2
    1229984001American Joint Committee on Cancer cN3
    1229945006American Joint Committee on Cancer pNX
    1229947003American Joint Committee on Cancer pN0
    1229951001American Joint Committee on Cancer pN1
    1229957002American Joint Committee on Cancer pN2
    1229962001American Joint Committee on Cancer pN3
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    UNKunknown**Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)


Entry 9

Request:

PUT ValueSet/TNMDistantMetastasesVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    1229901006American Joint Committee on Cancer cM0
    1229903009American Joint Committee on Cancer cM1
    1229916009American Joint Committee on Cancer pM1
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    UNKunknown**Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)


Entry 10

Request:

PUT ValueSet/EstrogenStatusVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    373572006Clinical finding absent
    416053008Estrogen receptor positive tumor
    416237000Procedure not done
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    UNKunknown**Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)


Entry 11

Request:

PUT ValueSet/ProgesteroneStatusVS

Resource ValueSet:

This value set includes codes based on the following rules:

  • Include these codes as defined in http://snomed.info/sct
    CodeDisplay
    441118006Progesterone receptor negative neoplasm
    416561008Progesterone receptor positive tumor
    416237000Procedure not done
  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    UNKunknown**Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)


Entry 12

Request:

PUT ValueSet/HER2ReceptorStatusVS

Resource ValueSet:


Entry 13

Request:

PUT CodeSystem/MolecularProfilingCodeSystem

Resource CodeSystem:

This code system http://hl7.org/fhir/uv/ichom-breast-cancer/CodeSystem/MolecularProfilingCodeSystem defines the following codes:

CodeDisplay
mammaprint Mammaprint Score
oncotype Oncotype Score
endopredict Endopredict Score


Entry 14

Request:

PUT ValueSet/MolecularProfilingStatusVS

Resource ValueSet:


Entry 15

Request:

PUT ValueSet/RecommendedTreatmentTypeVS

Resource ValueSet:

This value set includes codes based on the following rules:


Entry 16

Request:

PUT Questionnaire/ClinicalResponseBaseline

Resource Questionnaire:

LinkIdTextCardinalityTypeFlagsDescription & Constraintsdoco
.. ClinicalResponseBaselineQuestionnairehttp://hl7.org/fhir/uv/ichom-breast-cancer/Questionnaire/ClinicalResponseBaseline
... General-Information-ClinicalGeneral information1..1group
.... NA-ClinicalWhat is the patient's medical record number?1..1stringExpressions:
.... LastName-ClinicalWhat is the patient's last name?1..1stringExpressions:
... DemographicsDemographic factors1..1group
.... SexIndicate the sex of the patient at birth:1..1choiceValue Set: AdministrativeGender
Expressions:
  • Initial Value: %expandedGender.expansion.contains.where(code=%patient.gender)
.... YearOfBirthIn what year was the patient born?1..1integerMax Length: 4
Expressions:
... Clinical-FactorsClinical factors1..1group
.... HeightIndicate the patient's body height1..1quantityicon
.... WeightIndicate the patient's weight.1..1quantityicon
.... LATERALIndicate the laterality of breast cancer1..1choiceValue Set: Laterality of breast cancer ValueSet
.... FIRSTBCIndicate if this is the first breast cancer1..1choiceValue Set: Yes, No and Unknown Valueset
.... NewBCIndicate if this is a new cancer on contralateral or ipsilateral breast1..1choiceEnable When: FIRSTBC = No (expandedYes-NoIndicator#N)
Value Set: Laterality of new cancer ValueSet
.... HistologicalDateKnownIs the date of histological diagnosis known?1..1boolean
.... HistologicalDiagnosisDateIndicate the initial date of histological diagnosis:1..1dateEnable When: HistologicalDateKnown = true
.... HISTOTYPEIndicate the histologic type of the tumor (select all that apply)1..*choiceValue Set: Histological type of the tumor ValueSet
.... MUTBCIndicate if the patient carries a germline mutation predisposing breast cancer1..*choiceValue Set: Germline Mutation ValueSet
.... GRADEINVIndicate the grade of the invasive component of tumor1..1choiceValue Set: Grading of tumor ValueSet
.... GRADEDCISIndicate the tumor grade of DCIS component of tumor1..1choiceValue Set: Grading of tumor ValueSet
.... TNMCT_BREASTIndicate the clinical tumor stage (per AJCC 8th Ed.):1..1choiceValue Set: TNM Primary Tumor ValueSet
.... TNMCN_BREASTIndicate the clinical nodal stage (per AJCC 8th Ed.):1..1choiceValue Set: TNM Regional Nodes ValueSet
.... TNMCM_BREASTIndicate the clinical distant metastasis (per AJCC 8th Ed.):1..1choiceValue Set: TNM Distant Metastases ValueSet
.... ERSTATUSIndicate if the estrogen receptor status is positive:1..1choiceValue Set: Estrogen receptor status ValueSet
.... PRSTATUSIndicate if the progesterone receptor status is positive:1..1choiceValue Set: Progesterone receptor status ValueSet
.... HER2STATUSIndicate if the HER2 receptor status is positive:1..1choiceValue Set: HER2 receptor status ValueSet
.... MolecularProfilingIndicate if a molecular profiling tool was used. If so, which one?1..1choiceValue Set: Molecular profiling
.... MammaprintIndicate the mammaprint score on a scale of 0.000 to 1.0001..1decimalEnable When: MolecularProfiling = Mammaprint Score (Molecular Profiling CodeSystem#mammaprint)
.... OncotypeIndicate the oncotype score on a scale of 0 to 1001..1decimalEnable When: MolecularProfiling = Oncotype Score (Molecular Profiling CodeSystem#oncotype)
.... EndopredictIndicate the endopredict score on a scale of 1.1 to 6.21..1decimalEnable When: MolecularProfiling = Endopredict Score (Molecular Profiling CodeSystem#endopredict)
... Treatment-VariablesTreatment variables1..1group
.... MultMeetIndicate if a multidisciplinary meeting was conducted1..1choiceValue Set: Yes, No and Unknown Valueset
.... MultRecTreatmentsWhich treatments did the multidisciplinary team recommend (select all that apply)?1..*choiceEnable When: MultMeet = Yes (expandedYes-NoIndicator#Y)
Value Set: Recommended treatment types ValueSet

doco Documentation for this format