FHIR Chat · Example descriptions for external examples · shorthand

Stream: shorthand

Topic: Example descriptions for external examples

view this post on Zulip David Hay (Aug 12 2021 at 22:42):

I'm getting a number of errors like the ones below for examples that are not generated by sushi. Where do I add the descriptions?

Unable to find ImplementationGuide.definition.resource.description for the resource Medication/ctpp-50000391000117104. Descriptions are strongly encouraged if they cannot be inferred from the resource to allow proper population of the artifact list.

view this post on Zulip Corey Spears (Aug 12 2021 at 23:27):

Not sure if this is related to xamples directly. Seems like this is a resource profile description that is missing. Are you missing a description in the profile definition in the fsh file?

Profile: NzfDocumentReference
Parent: DocumentReference
Id: NzfDocumentReference
Title: "DocumentReference resource for NZ Formulary"
Description: Description of DocumentReference resource for NZ Formulary"

view this post on Zulip David Hay (Aug 12 2021 at 23:38):

I did try that (in fact there were similar errors for the profile which went away after adding the description there).

As the IG is generated by sushi, I'm not sure where it can get descriptions for external resources... (Another reason why I prefer doing this all inside sushi!)

view this post on Zulip Corey Spears (Aug 12 2021 at 23:52):

OK, I tracked it down. You need to add some entries in sushi-config.yaml for externally defined resources. I added the following into your IG locally and those warning went away:

resources:
  Medication/ctpp-50000391000117104:
    name: Medication Example 1
    description: Medication Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication
  Medication/ctpp-50079341000117105:
    name: Medication Example 1
    description: Medication Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication
  Medication/ctpp-with-funding:
    name: Medication Example 1
    description: Medication Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication
  Medication/mp-ibuprofen-10013251000116106:
    name: Medication Example 1
    description: Medication Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication
  Medication/mpuu-ibuprofen-200-mg-capsule-10013271000116104:
    name: Medication Example 1
    description: Medication Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication
  Medication/tpuu-10013331000116105:
    name: Medication Example 1
    description: Medication Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication
  DocumentReference/medsafe-datasheet-document-reference-example:
    name: Doc Ref Example 1
    description: Doc Ref Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-documentreference
  DocumentReference/patient-information-leaflet-example:
    name: Doc Ref Example 1
    description: Doc Ref Example 1
    exampleCanonical: http://hl7.org.nz/fhir/StructureDefinition/nzf-documentreference

view this post on Zulip David Hay (Aug 12 2021 at 23:58):

Brilliant! Many thanks for doing this...

view this post on Zulip Chris Moesel (Aug 17 2021 at 17:18):

I don't remember for sure, but I think that if you put partial information in the config, that SUSHI will merge it w/ existing information it can find, so you might be able to get away with not specifying exampleCanonical. But again, I don't remember for sure, so you should test it before going too far with it.

Last updated: Apr 12 2022 at 19:14 UTC


An HL7 Website -