Stream: IG creation
Topic: Confusing Build Warning for Profile Name and Text
Nagesh Bashyam (Mar 20 2019 at 18:48):
I am getting 2 build warnings on a profile authored using spreadsheet which are confusing and would like to see if anyone else has experienced it and have a recommended fix or if it is a tooling issue.
The warnings are :
1. A resource should have narrative for robust management [text.div.exists()]
----- The narrative is generated by the ig publisher and it exists in the XML generated from the spreadsheet. So not sure why this warning is being generated.
2. Name should be usable as an identifier for the module by machine processing applications such as code generation [name.matches('A-Z{0,254}')]
--- Again this exists in the XML generated and looks right. So not sure why these are getting generated for each profile.
</text>
<url value="http://hl7.org/fhir/us/womens-health-registries/StructureDefinitio
n/procedure-crn"/>
<version value="1.0.0"/>
<name value="procedure_crn"/>
<title value="Procedure_CRN"/>
I have tried with the latest publisher and still get the same issue.
Thoughts/Suggestions/Resolutions ?
Lloyd McKenzie (Mar 20 2019 at 19:28):
It should be name.matches('[A-Z]([A-Za-z0-9_]){0,254}'). I.e. it needs to be UpperCamelCase (possibly with underscores). So a name of ProcedureCRN or Procedure_CRN would work.
Lloyd McKenzie (Mar 20 2019 at 19:29):
The text.div.exists() issue is a problem with the warning triggering before the narrative gets generated or something. @Grahame Grieve is aware, but because it's not an error, it's lower priority.
Grahame Grieve (Mar 20 2019 at 19:46):
I know about it? how do I reproduce it?
Eric Haas (Mar 20 2019 at 21:17):
It should be name.matches('A-Z{0,254}'). I.e. it needs to be UpperCamelCase (possibly with underscores). So a name of ProcedureCRN or Procedure_CRN would work.
I just realized that the warning is due to lower case not 'foo_bar' and must be 'Foo_bar' that seems arbitrary?
foo_bar is just as good a Foo_bar to a computer language and a lot easier to create from id ( {id}.lower().snakecase())
Eric Haas (Mar 20 2019 at 21:17):
Why begin with [A-Z]
Grahame Grieve (Mar 20 2019 at 21:25):
types typically begin with an uppercase.
Eric Haas (Mar 20 2019 at 21:26):
OK
Nagesh Bashyam (Mar 21 2019 at 03:03):
Looks like the Narrative Build Warning is no longer an issue in the CI build. Did you fix something @Grahame ?
I used to get it for https://github.com/HL7/coordinated-registry-network before and it is not occuring anymore.
The Name was not following the regex pattern and i updated it. Thanks.
Grahame Grieve (Mar 21 2019 at 03:17):
yes I fixed it
Last updated: Apr 12 2022 at 19:14 UTC
