**IHE <Domain Name>**
**Technical Framework Supplement**
**<Profile Name**
**(Profile Acronym) >**
<For FHIR based profiles, indicate the FHIR release & the FMM levels
of the contents. Delete otherwise.>
HL7® FHIR® STU x
Using Resources at FMM Level n-n
**Revision x.x – Draft in Preparation for Public Comment (*or* Trial
Implementation)**
<The IHE Documentation Specialist will change the title to just
“Draft for Public Comment” or “Trial Implementation” upon publication.
Leave “as is” until then.>
Date: <Month xx, 20xx>
Author: <Domain> Technical Committee
Email: <domain\_name@ihe.net>
**Please verify you have the most recent version of this document.** See
[here](http://ihe.net/Technical_Frameworks/) for Trial Implementation
and Final Text versions and [here](http://ihe.net/Public_Comment/) for
Public Comment versions.
<Instructions to authors are encapsulated in angled brackets as “<
… >” and denoted with italicized text. These instructions should be
deleted entirely prior to publication.>
<Use of capitalization: Please follow standard English grammar
rules-only proper nouns and names are upper case. For example, “Modality
Actor” is upper case, but “an actor which fulfills the role of a
modality” is lower case. Do not use upper case to emphasize a
word/topic. Examples:
<Note: Before creating a draft supplement, please review the editing
conventions, which include information such as section, table and
diagram numbering and how to use Microsoft Word tools, at
Figure X.1-1: <Profile Acronym> Actor Diagram
Table X.1-1 lists the content module(s) defined in the <Profile
Acronym> Profile. To claim support with this profile, an actor shall
support all required content modules (labeled “R”) and may support
optional content modules (labeled “O”).
<Note that this table number has to change if this profile describes
both transactions and content modules (or there will be two tables
entitled X.1-1).>
<Note that the abbreviation in the column “Reference” the letter “D”
will be incremented for every content module document defined in this
profile (e.g., For example D1, D2).>
<In general, one supplement template will only contain one required
content module document, but the example here shows multiple with one
optional, just for illustration purposes.>
Table X.1-1 <Profile Acronym> – Actors and Content Modules
| Actors | Content Modules | Optionality | Reference |
|------------------|---------------------------------------|-------------------------|--------------------------------------|
| Content Creator | Content Module 1 Name and Template ID | R | <Domain Acronym> TF-3: 6.3.1.D |
| | Content Module 2 Name and Template ID | O See Note 1 | <Domain Acronym> TF-3: 6.3.1.D |
| Content Consumer | Content Module 1 Name and Template ID | O See Note 1 | <Domain Acronym> TF-3: 6.3.1.D |
| | Content Module 2 Name and Template ID | R | <Domain Acronym> TF-3: 6.3.1.D |
Note 1: *<For example, a note could describe that one of two possible
transactions could be supported by an actor or other variations.*
*For example - Note 1: Either Content Module 2 or Content Module 3 shall
be implemented for the Content Creator or Content Consumer.*
*For example- Note 1: At least one of Content Module 2, Content Module
3, or Content Module 4 shall be implemented for Content Consumer.>*
### X.1.1 Actor Descriptions and Actor Profile Requirements
*<For Workflow Profile:>*
Most requirements are documented in <DOM> TF-2 Transactions. This
section documents any additional requirements on profile’s actors.
<Enter here “No additional requirements needed.”, if none.>
*<For Content Module Profile:>*
Most requirements are documented in <DOM> TF-3 T Content Modules.
This section documents any additional requirements on profile’s actors.
<Enter here “No additional requirements needed.”, if none.>
<**Do not repeat** the definitions of the actors that are maintained
in the [TF General Introduction Appendix
A](http://ihe.net/Technical_Frameworks/#GenIntro) (Actors). Include text
in this section to describe the actor in the context of this
profile.>
<**This section is empty unless there is a need for specific
descriptions or requirements. Actors without additional requirements or
elaborate descriptions need not be listed here.** >
<If this is a Workflow Profile the sequence of transactions often
require data from an inbound transaction to be carried forward to
subsequent transactions . Individual transactions, which are designed to
be reusable, do not define this data mapping and it must be documented
here. If this is a long technical mapping, consider including this
material in an appendix to Volume 2. For an example, see Radiology
Scheduled Workflow RAD TF-2: Appendix A.>
<This section may also define system behavior. For example, in the
PIX Profile, an ADT message is first received by the PIX Manager. The
PIX Manager should then use this data to respond to subsequent queries.
Although this may be implied, it should be explicitly documented in this
section.>
<Note that for actors in, bindings to other transport or workflow
modules are referenced in the Required Actor Groupings section below.
>
#### X.1.1.1 <Actor A>
<If the summary description of the actor in Appendix A is
insufficient to understand its role in this profile, elaborate here.>
<Requirements on actors are predominantly contained inside
transactions in Volume 2. The main requirement on actors contained in
Volume 1 is to support the transactions identified in Table X.1-1 and
the content modules identified in Table Z. Requirements that do not fit
in those locations may be placed here.>
#### X.1.1.2 <Actor B>
X.2 <Profile Acronym> Actor Options
-----------------------------------------
<Modify the following table, listing all the actors in this profile,
the options available for each, and references to sections that state
requirements for compliance to each option. For actors with no options,
state “No options defined” in column 2.>
<Note: Options are directly carried over to the integration
statements which are published by vendors for review by buyers. Too many
options can be confusing for readers, so try to **minimize** options for
actors and only use if necessary.>
<Several options for Content Consumers are defined in PCC TF-2:
3.1.1-3.1.4. It is recommended that these options are reused, if
applicable, but read the option definitions thoroughly to be certain
that they apply. If they do not apply in their entirety, you will need
to define a corresponding option in this profile. The recommended naming
convention for a similar, but different, option is, for example, “View
Option - <profile acronym>, etc., “View Option – CIRC”.>
**Options tha**t may be selected for each actor in this profile, if any,
are listed in the Table X.2-1. Dependencies between options, when
applicable, are specified in notes.
Table X.2-1: <Profile Name> – Actors and Options
| Actor | Option Name | Reference |
|---|---|---|
| Actor A | <Option 1 name> Option | <reference to applicable X.2.x sub-section below table> |
| Actor B | No options defined | -- |
| Actor C | <Option 2 name> Option | <reference to applicable X.2.x sub-section below table> |
| Actor D | <Option 1 name> Option <Note that it is OK to have the same option apply to more than one actor. The option adds specific functionality in a profile. The actors will have different requirements identified in Section X.2.X to enable that functionality.> |
<reference to applicable sub-section below table, e.g., Section X.2.1> |
| Actor E, <e.g., Content Consume> (See Note) | View Option | PCC TF-2: 3.1.1 |
| Document Import Option | PCC TF-2: 3.1.2 | |
| Section Import Option | PCC TF-2: 3.1.3 | |
| Discrete Data Import Option | PCC TF-2: 3.1.4 |
| <this Profile Acronym> Actor | Actor(s) to be grouped with | Reference | Content Bindings Reference |
|---|---|---|---|
| Actor A | <external Domain Acronym or blank> <profile acronym>/<Actor> <e.g., ITI CT / Time Client> |
<TF Reference; typically from Vol 1> <e.g., ITI-TF-1: 7.1> |
-- |
| Actor B | None | -- | -- |
Actor C <In this example, Actor C shall be grouped with all three actors listed in column 2> |
<external Domain Acronym or blank> <profile acronym>/<Actor> |
-- | See Note 1 |
| <external Domain Acronym or blank> <profile acronym>/<Actor> | -- | See Note 1 | |
<external Domain Acronym or blank> <profile acronym>/<Actor> |
-- | See Note 1 | |
Actor D (See note 1) <In this example, the note is used to indicate that the Actor D shall be grouped with one or more of the two actors of the two actors in column 2.> |
<external Domain Acronym or blank> <profile acronym>/<Actor> |
-- | See Note 1 |
<external Domain Acronym or blank> <profile acronym>/<Actor> |
-- | See Note 1 | |
Actor E <In rare cases, the actor to be grouped with must implement an option. An example is in column 2.) |
<external Domain Acronym or blank> <profile acronym> <Actor> <e.g., ITI RFD Form Filler with the Archive Form Option> |
<TF Reference to the Option definition; typically from Vol 1> <(e.g., ITI TF-1: 17.3.11)> |
|
| <e.g., Content Consumer (See Note 1) | ITI XDS.b / Document Consumer | ITI TF-1: 10.1 | PCC TF-2:4.1 (See Note 2)> |
| ITI XDR / Document Recipient | ITI TF-1: 15.1 | PCC TF-2:4.1 (See Note 2)> | |
| ITI XDM / Portable Media Importer | ITI TF-1: 16.1 | PCC TF-2:4.1 (See Note 2)> | |
| <e.g., Content Consumer | ITI CT / Time Client | ITI TF-1: 7.1> | -- |
| <this Profile Acronym> Actor | Grouping Condition | Actor(s) to be grouped with | Reference |
| Actor A | -- | None | -- |
| Actor B | Required | <external Domain Acronym or blank> <profile acronym>/<Actor> <e.g., ITI CT / Time Client> |
<TF Reference; typically from Vol 1> <(e.g., ITI TF-1: 7.1)> |
| Actor C | With the <Option name in this profile> Option | <external Domain Acronym or blank> <profile acronym>/<Actor> | Where the Option is defined in this profile <Section x.3 z> |
Actor D <if an actor has both required and conditional groupings, list the Required grouping first> |
Required | <external Domain Acronym or blank> <profile acronym>/<Actor> | <TF Reference; typically from Vol 1> |
| If the <Option name in this profile> Option is supported. | <external Domain Acronym or blank> <profile acronym>/<Actor> | <TF Reference; typically from Vol 1> | |
| If the <other Option name in this profile> Option is supported. | <external Domain Acronym or blank> <profile acronym>/<Actor> | <TF Reference; typically from Vol 1> | |
Actor E (In rare cases, the actor to be grouped with must implement an option, an example is in column 3) |
Required | <external Domain Acronym or blank> <profile acronym>/<Actor> with the <option name> <e.g. ITI RFD Form Filler with the Archive Form Option> |
<TF Reference to the Option definition; typically from Vol 1> <(eg ITI TF-1:17.3.11)> |
| Role: | <Role Name:><Only unique within this transaction. Typically one word. The Role Name is analogous to SCU or SCP in DICOM Services.> |
|---|---|
| Actor(s): | The following actors may play the role of <Role Name>: <Actor Name>: <optionally, the situation where the actor would play this role if needed for clarity.>” |
| Role: | <e.g., Requestor: Submits the relevant details and requests the creation of a new workitem.> |
| Actor(s): | <e.g., The following actors may play the role of Requestor: Workitem Creator: when requesting workitems Workitem Performer: when performing unscheduled workitems> |
| Role: | <e.g., Manager: Creates and manages a Unified Procedure Step instance for the requested workitem.> |
| Actor(s): | <e.g., The following actors may play the role of Manager: Workitem Manager: when receiving a new workitem for its worklist.> |
| ACC Key Data Element (KDECI) | CDA-DIR |
|---|---|
| DICOM Object Catalog (5) | |
Administrative Facility (5) Data Source (1) Priority (1) Accreditation (2) Insurance (1) |
CDA Header General (10) Document (19) Participants (20) Order (1) Service Event (12) Encounter (10) |
| Study Referral Data (2) | Request |
History and Risk Factors Vital Signs (4) Labs (2) Problems (14) Chest Pain (5) Family History (1) Tobacco Use (1) Risk Estimates (6) |
History |
| Template Name | <Template Name (Acronym, if applicable)> | ||||
| Template ID | <oid/uid> | ||||
| Parent Template | <Parent Template Name oid/uid [Domain Reference]> <Parent Template Name oid/uid [Domain Reference]> <delete 2nd/additional parent template if not applicable> <Enter NA if none> |
||||
| General Description | <short textual description> | ||||
| Document Code | <MAY or SHALL> be < code/oid/uid, Code System, “Value Set name”> | ||||
| Opt and Card | Condition | Header Element or Section Name | Template ID | Specification Document | Vocabulary Constraint |
| Header Elements | |||||
| x [?..?] | <Header Element name> | <oid> | <reference to section of TF or supplement document for details> | <reference to section of TF or supplement document for explanation, if applicable> | |
| <e.g., R [0..1] | Order | 1.3.6.1.4.1.19376.1.4.1.3.2 | CARD TF-3 6.3.2.H> | ||
| <e.g., M [1..1] | Patient Demographics | 1.3.6.1.4.1.19376.1.4.1.3.3 | CARD TF-3 6.3.2.H | CARD TF-3 6.3.1.D.5.1> | |
| Sections | |||||
| x [?..?] | <Section name> | <oid> | <reference to section of TF or supplement document for details> | <reference to section of TF or supplement document for explanation, if applicable> | |
| <e.g., M [1..1] | Medications | 1.3.6.1.4.1.19376.1.5.3.1.3.19 | PCC TF-2 | CARD TF-3 6.3.1.D.5.2> | |
| <e.g., R [1..1] | Coded Social History | 1.3.6.1.4.1.19376.1.5.3.1.3.16.1 | CARD TF-3 6.3.3.S | CARD TF-3 6.3.1.D.5.3> | |
| <e.g., O [0..1] | Physical Examination | 2.16.840.1.113883.10.20.2.10 | CDA-PN> | ||
| <e.g., C [1..1] | CARD TF-3 6.3.1.D.5.4 | DICOM Object Catalog | 1.3.6.1.4.1.19376.1.4.1.2.15 | CDA-PN> |
| Template Title | Opt and Card | Condition | Template Type | templateId | Vocabulary Constraints |
|---|---|---|---|---|---|
| Delete this row and the example information in the rows below. | |||||
| <e.g., Cath Report Content | R[1..1] | document | 1.3.6.1.4.1.19376.1.4.1.1.2 | 6.3.1.D.5.1 | |
| Document Summary-Cardiac Section | O[0..1] | Section | 1.3.6.1.4.1.19376.1.4.1.2.16 | ||
| Medical History - Cardiac Section | R[1..1] | Section | 1.3.6.1.4.1.19376.1.4.1.2.17 | ||
| Procedure Activity Observation | O[0..*] | Entry | 2.16.840.1.113883.10.20.22.4.13 | ||
| Procedure Activity Procedure | O[0..*] | Entry | 2.16.840.1.113883.10.20.22.4.14 | ||
| Problem Observation - Cardiac | O[0..*] | Entry | 2.16.840.1.113883.10.20.22.4.4 | ||
| Age Observation | O[0..1] | Entry | 2.16.840.1.113883.10.20.22.4.31 | ||
| Health Status Observation | O[0..1] | 6.3.1.D.5.2 | Entry | 2.16.840.1.113883.10.20.22.4.5 | |
| Problem Status | O[0..1] | Entry | 2.16.840.1.113883.10.20.22.4.6 | ||
| Severity Observation | O[0..1] | Entry | 2.16.840.1.113883.10.20.22.4.8 | ||
| Allergies Section | R[1..1] | Section | 2.16.840.1.113883.10.20.22.2.6 | ||
| Allergy Problem Act | O[0..*] | Entry | 2.16.840.1.113883.10.20.22.4.30 | ||
| Allergy Observation | R[1..*] | Entry | 2.16.840.1.113883.10.20.22.4.7 | ||
| Allergy Status Observation | O[0..1] | Entry | 2.16.840.1.113883.10.20.22.4.28 | ||
| Reaction Observation | O[0..1] | Entry | 2.16.840.1.113883.10.20.22.4.9 | ||
| Severity Observation | O[0..1] | Entry | 2.16.840.1.113883.10.20.22.4.8 | ||
| Family History – Cardiac Section | O[0..1] | Section | 1.3.6.1.4.1.19376.1.4.1.2.18 | ||
| Problem Observation - Cardiac | O[0..*] | Entry | 2.16.840.1.113883.10.20.22.4.4 | ||
| Social History Section | O[0..1] | Section | 2.16.840.1.113883.10.20.22.2.17 | ||
| Physical Exam Section | R[1..1] | Section | 2.16.840.1.113883.10.20.2.10 | ||
| Vital Signs | R[1..1] | Section | 2.16.840.1.113883.10.20.22.2.4.1 | ||
| Vital Signs Organizer | R[1..*] | Entry | 2.16.840.1.113883.10.20.22.4.26 | ||
| Vital Sign Observation | R[2..*] | Entry | 2.16.840.1.113883.10.20.22.4.27> |
| Template Name | <Template Name> | ||||
| Template ID | <oid> | ||||
| Parent Template | <Name and oid of parent template or NA> | ||||
| Header Element | <CDA Header Elements participant or componentOf or NA> e.g., componentOf / encompassingEncounter |
||||
| General Description | <short textual description. Short paragraph at most.> | ||||
| Opt and Card | Participation/ Act Relationship | Description | Template | Specification Document | Vocabulary Con-straint |
| x [?..?] | <select from defined part /act relationship terms; App E> | <Header Content description name> | <oid> | <document reference, if applicable> | <Vocab constraint, if applicable> |
| <e.g., R [1..1] | RESP | Responsible Party | CARD TF-3: 6.3.2.H.1> | ||
| <e.g., R [1..1] | LOC | Health Care Facility | CARD TF-3: 6.3.2.H.2> | ||
| <e.g., O [0..1] | REF | Referring Provider | CARD TF-3: 6.3.2.H.3> | ||
| <e.g., C [0..1] | ATND | Physician of Record | 2.16.840.1.113883.10.20.6.2.2 | CDA-DIR | CARD TF-3: 6.3.2.H.4> |
Value Set: ProcedureNoteDocumentTypeCodes 2.16.840.1.113883.11.20.6.1 DYNAMIC Code System: LOINC 2.16.840.1.113883.6.1 |
|||
|---|---|---|---|
| LOINC Code | Type of Service ‘Component’ | Setting ‘System’ | Specialty/Training/Professional Level ‘Method_Type’ |
| 18745-0 | Study report | Heart | Cardiac catheterization |
| 34896-1 | Interventional procedure note | {Setting} | Cardiology |
| Template Name | <exact same Section Module name listed above> | ||||
| Template ID | <oid> | ||||
| Parent Template | <Parent Template Name oid/uid [Domain - Reference] or NA> | ||||
| General Description | <brief textual description, one paragraph> | ||||
| Section Code | <Code, Code Scheme, “Section Code Name”> | ||||
| Author | <If inherited from encompassing content module use “current recordTarget”, unless otherwise specified. Role and entity must be specified if not inherited. > | ||||
| Informant | <If inherited from encompassing content module use “current recordTarget”, unless otherwise specified.> | ||||
| Subject | <If inherited from encompassing content module use “current recordTarget”, unless otherwise specified.> | ||||
| Opt and Card | Condition | Data Element or Section Name | Template ID | Specification Document | Vocabulary Constraint |
| Subsections | |||||
| x [?..?] | <ref or link to cond section below, if applicable> | <name of subsection> | <oid> | <reference or link to specification document location, if applicable> | <reference or link to vocab constraint, if applicable> |
| <e.g., O [0..1] | Active Problems | 1.3.6.1.4.1.19376.1.5.3.1.3.6 | PCC TF-3> | ||
| <e.g., O [0..1] | History of Present Illness | 1.3.6.1.4.1.19376.1.5.3.1.3.4 | PCC TF-3> | ||
| <e.g., O [0..1] | History of Past Illness | 2.16.840.1.113883.10.20.2.9 | CDA-PN> | ||
| Entries | |||||
| x [?..?] | <ref or link to cond section below, if applicable> | <name of entry> | <oid> | <reference or link to specification document location, if applicable> | <reference or link to vocab constraint, if applicable> |
| <e.g., C [1..*] | CARD TF-3 6.3.3.x.S.1 | Problem Concern Entry | 1.3.6.1.4.1.19376.1.5.3.1.4.5.2 | PCC TF-3> | |
| <e.g., C [1..1] | Diabetes Problem Entry | 1.3.6.1.4.1.19376.1.4.1.4.1 | CARD TF-3 6.3.3.1> | ||
| <e.g., C [1..1] | Angina Problem Entry | 1.3.6.1.4.1.19376.1.4.1.4.2 | CARD TF-3 6.3.3.1> | ||
| <e.g., C [1..*] | CARD TF-3 6.3.3.x.S.1 | Simple Observation | 1.3.6.1.4.1.19376.1.5.3.1.4.13 | PCC TF-3 | CARD TF-3 6.3.3.x.S.2> |
| Opt and Card | Condition | observation/code | Data Type | Unit of Measure | Value Set/ Concept Domain |
|---|---|---|---|---|---|
| <e.g., C [1..*] | <Identifies the predicate and the if the predicate evaluates as true, then indicate whether mandatory, required or optional e.g., Required if “exam type” is “LVG” (left ventriculogram)> R: LVG |
60797005, SNOMED CT, “Cardiac Wall Motion” <”+” = May be post-coordinated with priorityCode, methodCode, targetSiteCode . See HL7 V3. Include a value directly or include a link to a value set, if applicable.> e.g., + targetSiteCode from 1.2.840.10008.6.1.219 DICOM CID 3718 Myocardial Wall Segments in Projection |
CD | n/a unless the Data Type is PQ or IVL<PQ> | <include link to value set, e.g., 1.3.6.1.4.1.19376.1.4.1.5.20 Wall motion OR, include value directly as e.g., <The Observation Value may also have a post-coordinated interpretation such as:> +interpretationCode +negationInd > |
| <e.g., C [1..*] | R: SPECT, TTE, TEE, CMR O:CCTA |
60797005, SNOMED CT, “Cardiac Wall Motion” + targetSiteCode from 1.2.840.10008.6.1.218 DICOM CID 3717 Myocardial Wall Segments |
CD | n/a | UV_WallMotion > |
| Opt and Card | Condition | observation/code | Data Type | Unit of Measure | Value Set/ Concept Domain |
|---|---|---|---|---|---|
| <e.g., C [1..*] | R: Cath with LVG | 72724002, SNOMED CT, “Morphology findings” + targetSiteCode from 1.2.840.10008.6.1.219 DICOM CID 3718 Myocardial Wall Segments in Projection |
CD | n/a | 1.3.6.1.4.1.19376.1.4.1.5.19 Myocardium Assessments> |
| <e.g., C [1..*] | R: SPECT, echo, CMR O:CCTA |
72724002, SNOMED CT, “Morphology findings” + targetSiteCode from 1.2.840.10008.6.1.218 DICOM CID 3717 Myocardial Wall Segments |
CD | n/a | UV_MyocardiumAssessments> |
Coding Scheme Concept |
<Coding Scheme Name> |
|---|---|
Coding Scheme Concept |
SNOMED CT | NDF-RT |
|---|---|---|
| Calcium channel blockers | 48698004 | N0000029119 |
| Beta-blockers | 33252009 | N0000029118 |
| Nitrates | 31970009 | N0000007647 |
| Aminophylline | 55867006 | N0000146397 |
Coding Scheme Concept |
SNOMED CT | NDF-RT |
|---|---|---|
| Calcium channel blockers | 48698004 | N0000029119 |
| Beta-blockers | 33252009 | N0000029118 |
| Nitrates | 31970009 | N0000007647 |
| Aminophylline | 55867006 | N0000146397 |