FHIR Chat · Profile acronym · ihe

Stream: ihe

Topic: Profile acronym

Jose Costa Teixeira (Apr 27 2020 at 13:27):

Where would we put the profile acronym if we want to use it as a variable throughout the IG?
a) in a jekyll variable
b) an extension to the IG
c) part of the IG id? for example we can have a naming convention for the profiles like ihe.fhir.<domain>.<profile>
d)...?

John Moehrke (Apr 27 2020 at 13:36):

I certainly think that ( c ) is needed, and we have already setup a pattern for this. If there is an issue with the pattern, then we need to change it universally.

John Moehrke (Apr 27 2020 at 13:37):

but is that really the question about use of the acronym? I figured you were looking for the human readable string?

Jose Costa Teixeira (Apr 27 2020 at 13:49):

we need both, i think

John Moehrke (Apr 27 2020 at 13:52):

okay, I was thinking there were different needs. I think I have historically in narrative just used "this" when wanting to refer to the IG from within the IG. But do recognize sometimes it is helpful to use the acronym. Especially with html based publication. It would need to be carefully used as acronyms are never all that clear to all readers. You could auto href back to the index.html for the IG?

Jose Costa Teixeira (Apr 27 2020 at 13:52):

Rationale for this specific example - some pages, will be generated and must be the same across profiles - so we may need things like profile name, profile acronym, domain name (and acronym?)

Jose Costa Teixeira (Apr 27 2020 at 13:53):

John Moehrke said:

You could auto href back to the index.html for the IG?

can you clarify this? I don't understand

John Moehrke (Apr 27 2020 at 13:54):

sorry, I don't have the vocabulary you have... When the acronym is used in generating the human readable content, it should not just be text, but be hyperlinked to the home page of that IG.

John Moehrke (Apr 27 2020 at 13:55):

yes, profile name, profile acronym, domain, would all be good

John Moehrke (Apr 27 2020 at 13:56):

we don't yet have domain. we do have name, right? as in ImplementationGuide.name, and ImplementationGuide.title.

Jose Costa Teixeira (Apr 27 2020 at 13:59):

When the acronym is used in generating the human readable content, it should not just be text, but be hyperlinked to the home page of that IG.

i'm looking at this from the other side, I think - in some pages (e.g. index.html), we want to display the content of variables, instead of fixed text. When we do that, we can choose to link or not.

Jose Costa Teixeira (Apr 27 2020 at 13:59):

example:
image.png

John Moehrke (Apr 27 2020 at 14:00):

ah, yes

Jose Costa Teixeira (Apr 27 2020 at 14:00):

in here there are ate least 6 or 7 variables

John Moehrke (Apr 27 2020 at 14:01):

I am not finding a logical place in the ImplementationGuide resource for the IHE domain.

John Moehrke (Apr 27 2020 at 14:01):

except as you indicate a portion of the name string.

John Moehrke (Apr 27 2020 at 14:03):

note you can't use '.' in a name. Hence why my current IHE guidance for FHIR is using '_' as that is the ONLY separator allowed.

Jose Costa Teixeira (Apr 27 2020 at 14:04):

ok. I think we need to build up a list of variables we need and then decide where to put them

Jose Costa Teixeira (Apr 27 2020 at 14:06):

John Moehrke said:

note you can't use '.' in a name. Hence why my current IHE guidance for FHIR is using '_' as that is the ONLY separator allowed.

IG name is a string, right?

Jose Costa Teixeira (Apr 27 2020 at 14:06):

(i don't recall where that limitation is... I thought we had limitations on the id, but even that seems to support . and -

John Moehrke (Apr 27 2020 at 14:08):

name has an invariant on it

John Moehrke (Apr 27 2020 at 14:08):

variables is understood... but would it not be good to have them recorded in elements of the IG? I am thinking for management sake.

Jose Costa Teixeira (Apr 27 2020 at 14:09):

ah right, thanks

Jose Costa Teixeira (Apr 27 2020 at 14:09):

yes, as IG elements this is fine. This is why I am asking feedback.

Jose Costa Teixeira (Apr 27 2020 at 14:10):

My preference is to make an IHE profile of ImplementationGuide, that contains our extensions and constraints

John Moehrke (Apr 27 2020 at 14:12):

if that is what we must do, then yes that is what we would do. But we should not need to deviate on things like .name and .title... right? So we might need to add an extension for ihe-domain.

Jose Costa Teixeira (Apr 27 2020 at 14:14):

yes, an IHE profile of implementationGuide that contains those extensions

Jose Costa Teixeira (Apr 27 2020 at 14:16):

Name should be without dots. My option c has the dots in the id.
And we can add extensions for profile acronym, domain acronym, domain name,... as part of our IHE profile

Jose Costa Teixeira (Apr 27 2020 at 14:18):

This can potentially get confusing, so, for me:
"IHE profile on implementationGuide" = StructureDefinition that profiles ImplementationGuide for supporting the IHE needs, by constraints and extensions"

John Moehrke (Apr 27 2020 at 14:39):

Jose Costa Teixeira said:

This can potentially get confusing, so, for me:
"IHE profile on implementationGuide" = StructureDefinition that profiles ImplementationGuide for supporting the IHE needs, by constraints and extensions"

no. StructureDefinition (what FHIR calls a profile, but is NOT an IHE Profile). a SD is reused potentially in many ImplementationGuides. They have their own canonical URI (In IHE land this is domain.volume2/3.chapter). Even within an IHE profile it is not uncommon for a n"IHE Transaction" (which is made up of one or more StructureDefinition) in many IHE Profiles (Implementation Guides). Take for example the XDS Query, which is referenced by XDS, XCA, MPQ, etc. This is an important molecularity feature, a feature also native supported in FHIR SD.

John Moehrke (Apr 27 2020 at 14:40):

SD might be IHE domain specific, but are not tightly bound backward to the IG. The IG tightly binds forward to the SD. This enables a SD to be required of many IG.

Jose Costa Teixeira (Apr 27 2020 at 14:48):

That is not what i mean, and that is why i said it was confusing.

Jose Costa Teixeira (Apr 27 2020 at 14:49):

I mean a FHIR profile on the implementationGuide resource, where we define the IHE extensions that we want on each IHE profiles' ImplementationGuides

Jose Costa Teixeira (Apr 27 2020 at 14:49):

not profiling the FHIR resources inside an IHE profile, but profiling the ImplementationGuide resource itself

Jose Costa Teixeira (Apr 27 2020 at 14:52):

Practical example: we can slice the Implementation.Guide contact so that the first slice is a fixed value "IHE International" and the second slice is the committee e.g. "IHE Pharmacy, pharmacy@ihe.net"

Jose Costa Teixeira (Apr 27 2020 at 14:52):

(this is fun. Meta but fun)

Keith Boone (May 02 2020 at 11:12):

I grab them from /profile/@id and /profile/name in my "magic"

<profile xmlns="http://ainq.com/ig-definition" id="SANER" chapter='1' codingsystems="SanerBedType" valuesets="BedLocationOperationalStatus BedProperty BedType">
        <domain id="AI">
            <org>Audacious Inquiry</org>
            <name>Situational Awareness for Novel Epidemic Response</name>
            <description></description>
            <overview file="SANER-overview.md"/>
        </domain>
    <name>Situational Awareness for Novel Epidemic Response</name>

Keith Boone (May 02 2020 at 11:17):

But for ImplementationGuide: name would likely be acronym or perhaps domain_acronym (it's happened a small number of times that two domains have had the same acronym for a short while), and title would be the IHE "name" I think. HL7 IG's have HL7 as publisher, and committee as first contact, I'd probably do the same for IHE.

Jose Costa Teixeira (May 02 2020 at 11:18):

Yes. We just have to find the positions for those elements (likely some of them will be extensions)

Jose Costa Teixeira (May 02 2020 at 11:22):

I started by obtaining the profile acronym by using the last bit of the ig's id:
if the ig ihas id "ihe.pharm.mma", I extract the mma bit and uppercase it.

Jose Costa Teixeira (May 02 2020 at 11:22):

but that does not seem solid

Jose Costa Teixeira (May 02 2020 at 11:29):

Keith Boone said:

But for ImplementationGuide: name would likely be acronym or perhaps domain_acronym (it's happened a small number of times that two domains have had the same acronym for a short while), and title would be the IHE "name" I think. HL7 IG's have HL7 as publisher, and committee as first contact, I'd probably do the same for IHE.

I will capture these somewhere and their mappings:

• ihe_profile_name,
• ihe_profile_acronym,
• ihe_domain_acronym,
• ihe_domain_name,
• publisher,
• contact

Jose Costa Teixeira (May 02 2020 at 11:29):

to me "domain_acronym" would be "PCC" or "ITI" or "PHARM"

Jose Costa Teixeira (May 02 2020 at 11:30):

profile_acronym must take into account that there may be temporary duplicates (i did not know that)

Jose Costa Teixeira (May 07 2020 at 07:23):

Implementation question:
If we want the start page to show the domain like "IHE Pharmacy" below the logo here
https://build.fhir.org/ig/IHE/pharm-mma/

Jose Costa Teixeira (May 07 2020 at 07:23):

Can we use liquid for that?

Jose Costa Teixeira (May 07 2020 at 07:25):

In other words, can we use expressions on the variables and do {..ig.publisher} or {...ig.contact[0].name} ?

Jose Costa Teixeira (May 07 2020 at 07:26):

This can determine if some of these values might come from extensions e.g. domain_acronym

Grahame Grieve (May 08 2020 at 02:11):

yes.

Grahame Grieve (May 08 2020 at 02:11):

site.data.fhir.ig.contact[0].name[0]}}

Jose Costa Teixeira (May 08 2020 at 04:14):

so is it also possible to do {{site.data.fhir.ig.extension[0].extension[1].valueString}} ?

Jose Costa Teixeira (May 08 2020 at 04:15):

and can i put some sort of predicates to determine the extension by code instead of position?

Grahame Grieve (May 08 2020 at 04:19):

you'll have to look at Jekyll doco for that. the file you are reading out of is fhir.json in temp/_data

Last updated: Apr 12 2022 at 19:14 UTC