FHIR-47923 Consistent example titles/descriptions

HL7 · Oct 30, 2024 · 7bd05b6 · 7bd05b6
1 parent f092db2
commit 7bd05b6
Show file tree

Hide file tree

Showing 39 changed files with 78 additions and 78 deletions.
diff --git a/input/fsh/instances/DiagnosticReport-hemoglobin.fsh b/input/fsh/instances/DiagnosticReport-hemoglobin.fsh
@@ -1,7 +1,7 @@
 Instance: hemoglobin-of-DiagnosticReport
 InstanceOf: DiagnosticReport
-Title: "DiagnosticReport: hemoglobin example"
-Description: "DiagnosticReport: hemoglobin example"
+Title: "DiagnosticReport - Hemoglobin"
+Description: "DiagnosticReport - Hemoglobin"
 Usage: #example
 * id = "hemoglobin"
 * status = #final

diff --git a/input/fsh/instances/Flag-example.fsh b/input/fsh/instances/Flag-example.fsh
@@ -1,7 +1,7 @@
 Instance: 546482
 InstanceOf: Flag
-Title: "Alert IPS Flag Example"
-Description: "Alert IPS Flag Illustrative Example with Recommended Fields"
+Title: "Flag - Alert of Patient Immunocompromised"
+Description: "Flag - Alert of Patient Immunocompromised"
 Usage: #example
 * extension[0].url = "http://hl7.org/fhir/StructureDefinition/flag-priority"
 * extension[0].valueCodeableConcept = $flag-priority-code#PH "High priority"

diff --git a/input/fsh/instances/IPS-bundle-01.fsh b/input/fsh/instances/IPS-bundle-01.fsh
@@ -1,7 +1,7 @@
 Instance: IPS-examples-Bundle-01
 InstanceOf: Bundle
-Title: "IPS Bundle example"
-Description: "IPS Bundle example"
+Title: "Bundle - IPS with Data"
+Description: "Bundle - IPS with Data"
 Usage: #example
 * language = #en-GB
 * identifier.system = "urn:oid:2.16.724.4.8.10.200.10"

diff --git a/input/fsh/instances/IPS-bundle-with-immunization.fsh b/input/fsh/instances/IPS-bundle-with-immunization.fsh
@@ -1,7 +1,7 @@
 Instance: IPS-examples-Bundle-with-immunization
 InstanceOf: Bundle
-Title: "IPS Bundle example with Immunization"
-Description: "IPS Bundle example with Immunization section"
+Title: "Bundle - IPS with Required Sections and Immunization"
+Description: "Bundle - IPS with Required Sections and Immunization"
 Usage: #example
 * language = #en-GB
 * identifier.system = "urn:oid:2.16.724.4.8.10.200.10"

diff --git a/input/fsh/instances/Immunization-75680.fsh b/input/fsh/instances/Immunization-75680.fsh
@@ -1,7 +1,7 @@
 Instance: 75680
 InstanceOf: Immunization
-Title: "Immunization: Vaccin anti diphtérie-coqueluche-tétanos-poliomyélite (Luxembourg)"
-Description: "Immunization: Vaccin anti diphtérie-coqueluche-tétanos-poliomyélite (Luxembourg)"
+Title: "Immunization - Vaccin anti diphtérie-coqueluche-tétanos-poliomyélite (Luxembourg)"
+Description: "Immunization - Vaccin anti diphtérie-coqueluche-tétanos-poliomyélite (Luxembourg)"
 Usage: #example
 * language = #fr-LU
 * status = #completed

diff --git a/input/fsh/instances/MedicationRequest-eumfh-39-07-1-request.fsh b/input/fsh/instances/MedicationRequest-eumfh-39-07-1-request.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-1-request
 InstanceOf: MedicationRequest
-Title: "MedicationRequest: Simvastatin request"
-Description: "MedicationRequest: Simvastatin request"
+Title: "MedicationRequest - Simvastatin Request"
+Description: "MedicationRequest - Simvastatin Request"
 Usage: #example
 * status = #active
 * intent = #order

diff --git a/input/fsh/instances/Organization-simple-org.fsh b/input/fsh/instances/Organization-simple-org.fsh
@@ -1,6 +1,6 @@
 Instance: simple-org
 InstanceOf: Organization
-Title: "Organization: simple example"
-Description: "Very Simple Organization example"
+Title: "Organization - Minimal Name Only"
+Description: "Organization - Minimal Name Only"
 Usage: #example
 * name = "Best Diagnostic Department"
diff --git a/input/fsh/instances/PractitionerRole-simple-pr.fsh b/input/fsh/instances/PractitionerRole-simple-pr.fsh
@@ -1,7 +1,7 @@
 Instance: simple-pr
 InstanceOf: PractitionerRole
-Title: "PractitionerRole: simple example"
-Description: "Very Simple PractitionerRole example"
+Title: "PractitionerRole - Minimal"
+Description: "PractitionerRole - Minimal"
 Usage: #example
 * practitioner = Reference(Practitioner/eumfh-39-07)
 * organization = Reference(simple-org)
diff --git a/input/fsh/instances/allergyIntolerance-39-07-1.fsh b/input/fsh/instances/allergyIntolerance-39-07-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-1-of-AllergyIntolerance
 InstanceOf: AllergyIntolerance
-Title: "AllergyIntolerance: No known allergies"
-Description: "AllergyIntolerance: No known allergies"
+Title: "AllergyIntolerance - No Known Allergies"
+Description: "AllergyIntolerance - No known allergies"
 Usage: #example
 * id = "eumfh-39-07-1"
 * clinicalStatus = $allergyintolerance-clinical#active

diff --git a/input/fsh/instances/allergyIntolerance-with-abatement.fsh b/input/fsh/instances/allergyIntolerance-with-abatement.fsh
@@ -1,7 +1,7 @@
 Instance: allergyintolerance-with-abatement
 InstanceOf: AllergyIntolerance
-Title: "AllergyIntolerance: resolved allergy"
-Description: "AllergyIntolerance: resolved allergy"
+Title: "AllergyIntolerance - Resolved Allergy"
+Description: "AllergyIntolerance - Resolved Allergy"
 Usage: #example
 * extension.url = "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
 * extension.valueDateTime = "2010"

diff --git a/input/fsh/instances/allergyintolerance-multiple-codings.fsh b/input/fsh/instances/allergyintolerance-multiple-codings.fsh
@@ -1,7 +1,7 @@
 Instance: allergyintolerance-multiple-codings
 InstanceOf: AllergyIntolerance
-Title: "AllergyIntolerance: multiple codings"
-Description: "AllergyIntolerance: multiple codings"
+Title: "AllergyIntolerance - Multiple Codings"
+Description: "AllergyIntolerance - Multiple Codings"
 Usage: #example
 * clinicalStatus = $allergyintolerance-clinical#active
 * verificationStatus = $allergyintolerance-verification#confirmed

diff --git a/input/fsh/instances/bundle-minimal.fsh b/input/fsh/instances/bundle-minimal.fsh
@@ -1,7 +1,7 @@
 Instance: bundle-minimal
 InstanceOf: Bundle
-Title: "IPS Bundle example - minimal"
-Description: "IPS Bundle example - minimal"
+Title: "Bundle - Minimal Complete IPS"
+Description: "Bundle - Minimal Complete IPS"
 Usage: #example
 * language = #en-US
 * identifier.system = "urn:oid:2.16.724.4.8.10.200.10"

diff --git a/input/fsh/instances/bundle-no-info-required-sections.fsh b/input/fsh/instances/bundle-no-info-required-sections.fsh
@@ -1,7 +1,7 @@
 Instance: bundle-no-info-required-sections
 InstanceOf: Bundle
-Title: "IPS Bundle example - no information in required sections"
-Description: "IPS Bundle example - no information in required sections"
+Title: "Bundle - No Information in Required Sections"
+Description: "Bundle - No Information in Required Sections"
 Usage: #example
 * language = #en-NZ
 * identifier.system = "urn:oid:2.16.724.4.8.10.200.10"

diff --git a/input/fsh/instances/composition-minimal.fsh b/input/fsh/instances/composition-minimal.fsh
@@ -1,7 +1,7 @@
 Instance: composition-minimal
 InstanceOf: Composition
-Title: "IPS Composition example - minimal"
-Description: "IPS Composition example - minimal"
+Title: "Composition - Minimal Sections"
+Description: "Composition - Minimal Sections"
 Usage: #example
 * status = #final
 * type = $loinc#60591-5 "Patient summary Document"

diff --git a/input/fsh/instances/condition-39-07-1.fsh b/input/fsh/instances/condition-39-07-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-1-of-Condition
 InstanceOf: Condition
-Title: "Condition: Acute myeloid leukemia"
-Description: "Condition: Acute myeloid leukemia"
+Title: "Condition - Acute Myeloid leukemia"
+Description: "Condition - Acute Myeloid leukemia"
 Usage: #example
 * id = "eumfh-39-07-1"
 * clinicalStatus = $condition-clinical#active

diff --git a/input/fsh/instances/device-70-275-1.fsh b/input/fsh/instances/device-70-275-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-70-275-1-of-Device
 InstanceOf: Device
-Title: "Device: No known devices in use"
-Description: "Device: No known devices in use"
+Title: "Device - No Known Devices in Use"
+Description: "Device - No Known Devices in Use"
 Usage: #example
 * id = "eumfh-70-275-1"
 * type = $sct#787483001 "No known device use (situation)"

diff --git a/input/fsh/instances/device-imaging-example-1.fsh b/input/fsh/instances/device-imaging-example-1.fsh
@@ -1,7 +1,7 @@
 Instance: ips-example-imaging-1-of-Device
 InstanceOf: Device
-Title: "Device: device observer example"
-Description: "Device: device observer example"
+Title: "Device - Device Observer"
+Description: "Device - Device Observer"
 Usage: #example
 * id = "ips-example-imaging-1"
 * identifier.system = "http://my.organization.example/devicesID"

diff --git a/input/fsh/instances/deviceUseStatement-70-275-1.fsh b/input/fsh/instances/deviceUseStatement-70-275-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-70-275-1-of-DeviceUseStatement
 InstanceOf: DeviceUseStatement
-Title: "DeviceUseStatement: No known devices in use"
-Description: "DeviceUseStatement: No known devices in use"
+Title: "DeviceUseStatement - No Known Devices in Use"
+Description: "DeviceUseStatement - No Known Devices in Use"
 Usage: #example
 * id = "eumfh-70-275-1"
 * status = #active

diff --git a/input/fsh/instances/imagingStudy-imaging-ex-5-1.fsh b/input/fsh/instances/imagingStudy-imaging-ex-5-1.fsh
@@ -1,7 +1,7 @@
 Instance: TII-ImagingStudy-5-1
 InstanceOf: ImagingStudy
-Title: "ImagingStudy: referred DICOM study"
-Description: "ImagingStudy: referred DICOM study"
+Title: "ImagingStudy - Referred DICOM Study"
+Description: "ImagingStudy - Referred DICOM Study"
 Usage: #example
 * identifier.system = "urn:dicom:uid"
 * identifier.value = "urn:oid:2.16.840.1.113883.2.9.999.1.12345"

diff --git a/input/fsh/instances/medication-39-07-1.fsh b/input/fsh/instances/medication-39-07-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-1-of-Medication
 InstanceOf: Medication
-Title: "Medication : Simvastatin 40 MG Disintegrating Oral Tablet"
-Description: "Medication : Simvastatin 40 MG Disintegrating Oral Tablet"
+Title: "Medication - Simvastatin 40 MG Disintegrating Oral Tablet"
+Description: "Medication - Simvastatin 40 MG Disintegrating Oral Tablet"
 Usage: #example
 * id = "eumfh-39-07-1"
 * code.coding[0] = $rxnorm#757704 "Simvastatin 40 MG Disintegrating Oral Tablet"

diff --git a/input/fsh/instances/medicationStatement-39-07-1.fsh b/input/fsh/instances/medicationStatement-39-07-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-1-of-MedicationStatement
 InstanceOf: MedicationStatement
-Title: "MedicationStatement: on-going Simvastatin treatment"
-Description: "MedicationStatement: on-going Simvastatin treatment"
+Title: "MedicationStatement - Ongoing Simvastatin Treatment"
+Description: "MedicationStatement - Ongoing Simvastatin Treatment"
 Usage: #example
 * id = "eumfh-39-07-1"
 * status = #active

diff --git a/input/fsh/instances/observation-alcoholuse-1.fsh b/input/fsh/instances/observation-alcoholuse-1.fsh
@@ -1,7 +1,7 @@
 Instance: alcohol-use-example
 InstanceOf: Observation
-Title: "Observation: SH alcohol use example"
-Description: "Observation: SH alcohol use example"
+Title: "Observation - Social History Alcohol Use"
+Description: "Observation - Social History Alcohol Use"
 Usage: #example
 * status = #final
 * code = $loinc#74013-4 "Alcoholic drinks per day"

diff --git a/input/fsh/instances/observation-hemoglobin.fsh b/input/fsh/instances/observation-hemoglobin.fsh
@@ -1,7 +1,7 @@
 Instance: hemoglobin-of-Observation
 InstanceOf: Observation
-Title: "Observation: hemoglobin example"
-Description: "Observation: hemoglobin example"
+Title: "Observation - Result Hemoglobin"
+Description: "Observation - Result Hemoglobin"
 Usage: #example
 * id = "hemoglobin"
 * status = #final

diff --git a/input/fsh/instances/observation-imaging-example-1.fsh b/input/fsh/instances/observation-imaging-example-1.fsh
@@ -1,7 +1,7 @@
 Instance: ips-example-imaging-1-of-Observation
 InstanceOf: Observation
-Title: "Observation: imaging CT Abdomen W contrast IV"
-Description: "Observation: imaging CT Abdomen W contrast IV"
+Title: "Observation - Result Imaging CT Abdomen with Contrast IV"
+Description: "Observation - Result Imaging CT Abdomen with Contrast IV"
 Usage: #example
 * id = "ips-example-imaging-1"
 * status = #final

diff --git a/input/fsh/instances/observation-imaging-example-4.fsh b/input/fsh/instances/observation-imaging-example-4.fsh
@@ -1,7 +1,7 @@
 Instance: ips-example-imaging-4
 InstanceOf: Observation
-Title: "Observation: imaging CT Abdomen W contrast IV, sub-observations"
-Description: "Observation: imaging CT Abdomen W contrast IV,sub-observations"
+Title: "Observation - Result Imaging CT Abdomen with Contrast IV, Sub-observations"
+Description: "Observation - Result Imaging CT Abdomen with Contrast IV, Sub-observations"
 Usage: #example
 * partOf = Reference(TII-ImagingStudy-5-1)
 * status = #final

diff --git a/input/fsh/instances/observation-imaging-example-with-numeric-range-measurement.fsh b/input/fsh/instances/observation-imaging-example-with-numeric-range-measurement.fsh
@@ -1,7 +1,7 @@
 Instance: ips-example-imaging-5
 InstanceOf: Observation
-Title: "Observation: imaging Chest X-ray - PA and lateral, with additional sub-observation including numeric range"
-Description: "Observation: imaging Chest X-ray - PA and lateral, with additional sub-observation including numeric range"
+Title: "Observation - Result Imaging Chest X-ray - PA and Aateral, with Additional Sub-observation Including Numeric Range"
+Description: "Observation - Result Imaging Chest X-ray - PA and Aateral, with Additional Sub-observation Including Numeric Range"
 Usage: #example
 * partOf = Reference(TII-ImagingStudy-5-1)
 * status = #final

diff --git a/input/fsh/instances/observation-pathology-cancer.fsh b/input/fsh/instances/observation-pathology-cancer.fsh
@@ -1,7 +1,7 @@
 Instance: pathology-cancer
 InstanceOf: Observation
-Title: "Observation: estrogen receptor in tissue example"
-Description: "Observation: estrogen receptor in tissue example"
+Title: "Observation - Result Estrogen Receptor in Tissue Example"
+Description: "Observation - Result Estrogen Receptor in Tissue Example"
 Usage: #example
 * status = #final
 * category = $observation-category#laboratory

diff --git a/input/fsh/instances/observation-pregnancy-edd-1.fsh b/input/fsh/instances/observation-pregnancy-edd-1.fsh
@@ -1,7 +1,7 @@
 Instance: pregnancy-edd-example
 InstanceOf: Observation
-Title: "Observation: pregnancy edd example"
-Description: "Observation: pregnancy edd example"
+Title: "Observation - Pregnancy Expected Delivery Date (EDD)"
+Description: "Observation - Pregnancy Expected Delivery Date (EDD)"
 Usage: #example
 * status = #final
 * code = $loinc#11778-8 "Delivery date Estimated"

diff --git a/input/fsh/instances/observation-pregnancy-outcome-1.fsh b/input/fsh/instances/observation-pregnancy-outcome-1.fsh
@@ -1,7 +1,7 @@
 Instance: pregnancy-outcome-example
 InstanceOf: Observation
-Title: "Observation: pregnancy outcome example"
-Description: "Observation: pregnancy outcome example"
+Title: "Observation - Pregnancy Outcome"
+Description: "Observation - Pregnancy Outcome"
 Usage: #example
 * status = #final
 * code = $loinc#11640-0 "[#] Births total"

diff --git a/input/fsh/instances/observation-pregnancy-status-1.fsh b/input/fsh/instances/observation-pregnancy-status-1.fsh
@@ -1,7 +1,7 @@
 Instance: pregnancy-status-example
 InstanceOf: Observation
-Title: "Observation: pregnancy status example"
-Description: "Observation: pregnancy status example"
+Title: "Observation - Pregnancy Status"
+Description: "Observation - Pregnancy Status"
 Usage: #example
 * status = #final
 * code = $loinc#82810-3 "Pregnancy status"

diff --git a/input/fsh/instances/observation-serum-creatinine-adult.fsh b/input/fsh/instances/observation-serum-creatinine-adult.fsh
@@ -1,7 +1,7 @@
 Instance: serum-creatinine-adult
 InstanceOf: Observation
-Title: "Observation: serum creatinine example"
-Description: "Observation: serum creatinine example"
+Title: "Observation - Result Serum Creatinine"
+Description: "Observation - Result Serum Creatinine"
 Usage: #example
 * status = #final
 * category = $observation-category#laboratory

diff --git a/input/fsh/instances/observation-tobaccouse-1.fsh b/input/fsh/instances/observation-tobaccouse-1.fsh
@@ -1,7 +1,7 @@
 Instance: tobacco-use-example
 InstanceOf: Observation
-Title: "Observation: SH tobacco use example"
-Description: "Observation: SH tobacco use example"
+Title: "Observation - Social History Tobacco Use"
+Description: "Observation - Social History Tobacco Use"
 Usage: #example
 * status = #final
 * code = $loinc#72166-2 "Tobacco smoking status"

diff --git a/input/fsh/instances/observation-urine-wbc-range.fsh b/input/fsh/instances/observation-urine-wbc-range.fsh
@@ -1,7 +1,7 @@
 Instance: urine-wbc-range
 InstanceOf: Observation
-Title: "Observation: urine wbc range example"
-Description: "Observation: urine wbc range example"
+Title: "Observation - Result Urine White Blood Cell (WBC) Range"
+Description: "Observation - Result Urine White Blood Cell (WBC) Range"
 Usage: #example
 * status = #final
 * category = $observation-category#laboratory

diff --git a/input/fsh/instances/organization-imaging-example-1.fsh b/input/fsh/instances/organization-imaging-example-1.fsh
@@ -1,7 +1,7 @@
 Instance: TII-Organization1
 InstanceOf: Organization
-Title: "Organization: example"
-Description: "Organization: example"
+Title: "Organization - Hospital"
+Description: "Organization - Hospital"
 Usage: #example
 * name = "Someplace General Hospital"
 * address.line = "123 Street Address"

diff --git a/input/fsh/instances/organization-lab-example-1.fsh b/input/fsh/instances/organization-lab-example-1.fsh
@@ -1,7 +1,7 @@
 Instance: lab-org-example
 InstanceOf: Organization
-Title: "Organization: lab example"
-Description: "Best Hospital Lab Organization example"
+Title: "Organization - Laboratory"
+Description: "Organization - Laboratory"
 Usage: #example
 * active = true
 * type = $sct#73588009 "Hospital-based laboratory facility"

diff --git a/input/fsh/instances/patient-39-07-1.fsh b/input/fsh/instances/patient-39-07-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-of-Patient
 InstanceOf: Patient
-Title: "Patient: male patient"
-Description: "Patient: male patient"
+Title: "Patient - Male Alexander Hieg"
+Description: "Patient - Male Alexander Hieg"
 Usage: #example
 * id = "eumfh-39-07"
 * extension.url = "http://hl7.org/fhir/StructureDefinition/patient-citizenship"

diff --git a/input/fsh/instances/patient-example-female.fsh b/input/fsh/instances/patient-example-female.fsh
@@ -1,7 +1,7 @@
 Instance: patient-example-female
 InstanceOf: Patient
-Title: "Patient: female patient"
-Description: "Patient: female patient"
+Title: "Patient - Female Martha DeLarosa"
+Description: "Patient - Female Martha DeLarosa"
 Usage: #example
 * identifier.system = "urn:oid:2.16.840.1.113883.2.4.6.3"
 * identifier.value = "574687583"

diff --git a/input/fsh/instances/practictioner-39-07-1.fsh b/input/fsh/instances/practictioner-39-07-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-of-Practitioner
 InstanceOf: Practitioner
-Title: "Practitioner example"
-Description: "Practitioner example"
+Title: "Practitioner - Dr. Mark Antonio"
+Description: "Practitioner - Dr. Mark Antonio"
 Usage: #example
 * id = "eumfh-39-07"
 * name.family = "Antonio"

diff --git a/input/fsh/instances/procedure-39-07-1.fsh b/input/fsh/instances/procedure-39-07-1.fsh
@@ -1,7 +1,7 @@
 Instance: eumfh-39-07-1-of-Procedure
 InstanceOf: Procedure
-Title: "Procedure: Surgical procedure"
-Description: "Procedure: Surgical procedure"
+Title: "Procedure - Surgical Placement of Coronary Stent"
+Description: "Procedure - Surgical Placement of Coronary Stent"
 Usage: #example
 * id = "eumfh-39-07-1"
 * status = #completed