Stream: Ballot-QA
Topic: Editing Standards
Sheila Connelly (Mar 16 2018 at 17:13):
Are there any editing rules we should follow for consistency such as:
comma before and / or in a series
red, green, and blue
red, green, or blue
or no comma.
lower case vs. capital
v2 vs. V2
v3 vs. V3
punctuation inside or outside the quote.
"suspended." vs. "suspended".
Lloyd McKenzie (Mar 16 2018 at 17:42):
American style guide is to put commas before and/or. HL7 itself isn't consistent with v2 vs. V2. However, most common seems to be upper-case V, so I guess stick with that. Punctuation should reflect what what's happening. So if the sentence starts inside the quote or brackets, the final punctuation for the sentence should appear inside the brackets/punctuation too. For example: Sam asked, "Where should the puncutation go?".
Sheila Connelly (Mar 16 2018 at 17:56):
Thank you Lloyd.
Here is a trick to Test if there is a comma before and / or in a series:
Ctrl + H in Word on Windows opens the beloved Find and Replace dialog box.
Copy and paste the line below ending with 'and' into the Find what field.
([a-zA-Z0-9]{1,200}), ([a-zA-Z0-9]{1,200}) and
([a-zA-Z0-9]{1,200}), ([a-zA-Z0-9]{1,200}) or
Click More to reveal the Options. You must click Use wildcards.
Click Find Next
If found, manually correct, and then Find Next.
Repeat with the line above ending in 'or'
Simone Heckmann (Mar 17 2018 at 17:57):
I have found an element short description of "What is account tied to?". Is this legitimate, or should it be changed into a statement, like "What the account is tied to."
Simone Heckmann (Mar 17 2018 at 17:59):
Is something that is not a patient a "non patient" or a non-patient"?
Simone Heckmann (Mar 17 2018 at 18:02):
Um. I think it's "nonpatient" actually. That looks weird.
Lloyd McKenzie (Mar 17 2018 at 19:27):
"What the account is tied to" is better
Lloyd McKenzie (Mar 17 2018 at 19:27):
non-patient. nonpatient isn't a word.
Simone Heckmann (Mar 17 2018 at 19:53):
Ugh. Word adds a gazillion of pointless markups to every document, even if I didn't change anything. Is that a problem because I'm using another language version of Word or does this have to do with changing the filetype from html to docx?
pasted image
Simone Heckmann (Mar 17 2018 at 20:42):
Ok, so whoever will have to apply my changes should hide als formatting changes to make the markup usable....
Sheila Connelly (Mar 18 2018 at 02:27):
Ok, so whoever will have to apply my changes should hide all formatting changes to make the markup usable....
Can you Accept All Changes as soon as you open the document, and then after that the only changes marked will be your new ones.
Simone Heckmann (Mar 18 2018 at 09:45):
Don't we have a rule that says that all Element definitions have to start with upper case?
How come Element.id starts with "unique id for the element..."
Grahame Grieve (Mar 18 2018 at 10:51):
I don't know why there'd be a special case there
Simone Heckmann (Mar 18 2018 at 10:52):
Shouldn't the build tool complain about this unless there was an exception made?
Grahame Grieve (Mar 18 2018 at 10:55):
I think it should. I don't know why it doesn't
Simone Heckmann (Mar 18 2018 at 13:12):
Any idea, what this sentence is supposed to mean: " In the past, normative ballots have undergone may cycles of balloting, a process that can take years. "
Simone Heckmann (Mar 18 2018 at 13:13):
*many ?
Simone Heckmann (Mar 18 2018 at 13:15):
http://build.fhir.org/ballot-intro.html#process
Simone Heckmann (Mar 18 2018 at 13:16):
I was first thinking this referred to the "May cycle" (following the January cycle), but I guess "many" makes more sense :)
David Hay (Mar 18 2018 at 16:41):
'many' sounds right to me!
Bushra Khatoon (Mar 22 2018 at 19:08):
Hi all, when saving the html files as docs there's a few characters that appear such as  and “ where they shouldn't be - they're not as part of annotations or anything. Is there any recommendation on how these should be handled as part of the QA?
David Hay (Mar 22 2018 at 19:17):
Hi Bushra - which file?
Grahame Grieve (Mar 22 2018 at 19:23):
those are unicode errors - check that they don't exist in the real spec
Bushra Khatoon (Mar 22 2018 at 20:36):
@David Hay @Grahame Grieve see files listed below. The characters are present when I view the source files in a browser too.
Resources>deviceRequest-qa - relevantHistory - Comments
Resources>deviceRequest-qa - Search Parameters (requester, status)
Resources>device-qa - How to distinguish between the device instance or the kind
David Hay (Mar 22 2018 at 21:06):
Interestingly, I'll not seeing them. I have:
This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.
I suggest you mark then in your copy, and the committee can just check that there isn't anything weird in the source file...
Bushra Khatoon (Mar 23 2018 at 09:55):
Thanks, will do.
Wes Rishel (Mar 28 2018 at 23:11):
Lloyd, re commas before and/or.
A common construct I am finding is a comma before a conjunction that is not a series, such as "This SHOULD be globally unique and SHOULD be a literal address at which this graph definition is (or will be) published."
AFAIK (and I spent 15 years having my work edited by professional editors) this is not American usage. It is also flagged as incorrect by Word.
What I believe is that the "Oxford comma" after the penultimate item in a series of three or more things is expected. However, if there are only two items the comma should be removed. Is that correct?
Lloyd McKenzie (Mar 29 2018 at 01:07):
There wasn't a comma in your example, but I agree that no comma should have been there.
Last updated: Apr 12 2022 at 19:14 UTC
