Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R4B R4 R3

10.3.15.2 10.3.13.8 StructureDefinition: HLAResult Profile for HLA Genotyping Results

Orders and Observations Work Group   Maturity Level : 1 0 Trial Use Use Context : Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hlaresult

Describes how the HLA genotyping results

This profile was published on Fri, Oct 9, 2015 00:00+1100 Sat, May 12, 2012 00:00+1000 as a draft by Health Level Seven International (Clinical Genomics). Seven, Inc. - FHIR WG.

10.3.15.2.1 10.3.13.8.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .

Name Flags Card. Type Description & Constraints doco
. . DiagnosticReport I 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred ) ): IETF language tag
Max Binding:
Additional Bindings Purpose
All Languages Max Binding
. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension I 0..* Extension Extension
Slice: Unordered, Open by value:url
. . . hla-genotyping-results-allele-database I 0..1 CodeableConcept Allele Database
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-allele-database
. . . hla-genotyping-results-glstring I 0..1 (Complex) Glstring
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-glstring
. . . hla-genotyping-results-haploid I 0..* (Complex) Haploid
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-haploid
. . . hla-genotyping-results-method I 0..1 CodeableConcept The platform, methodology and software applied at the time of the genotyping
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-method
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . identifier Σ I 0..* Identifier Business identifier for report
. . . basedOn I 0..* Reference ( CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) What was requested
. . . status ?! Σ I 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus ( required ) ): The status of the diagnostic report.

. . . category Σ I 0..* CodeableConcept Service category
Binding: Diagnostic Service Section Codes ( example ) ): HL7 V2 table 0074


. . . code Σ I 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes ( preferred ) ): LOINC Codes for Diagnostic Reports

. . . subject Σ I 0..1 Reference ( Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance ) The subject of the report - usually, but not always, the patient
. . . encounter Σ I 0..1 Reference ( Encounter ) Health care event when test ordered
. . . effective[x] Σ I 0..1 Clinically relevant time/time-period for report
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . issued Σ I 0..1 instant DateTime this version was made
. . . performer Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Responsible Diagnostic Service
. . . resultsInterpreter Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Primary result interpreter
. . . specimen I 0..* Reference ( Specimen ) Specimens this report is based on
. . . result I 0..* Reference ( Observation ) Observations
. . . imagingStudy I 0..* Reference ( ImagingStudy ) Reference to full details of imaging associated with the diagnostic report
. . . media Σ I 0..* BackboneElement Key images associated with this report
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . comment I 0..1 string Comment about the image (e.g. explanation)
. . . . link Σ I 1..1 Reference ( Media ) Reference to the image source
. . . conclusion I 0..1 string Clinical conclusion (interpretation) of test results
. . . conclusionCode I 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMED CT Clinical Findings ( example ) ): SNOMED CT Clinical Findings


. . . presentedForm I 0..* Attachment Entire report as issued

doco Documentation for this format 
<!-- Profile for HLA Genotyping Results -->doco

<DiagnosticReport xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <

 <contained><!-- ?? 0..* Resource 

     Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- ?? 0..* Identifier 
     Business identifier for report --></identifier>
 <basedOn><!-- ?? 0..* Reference(CarePlan) What was requested --></basedOn>
 <status value="[code]"/><!-- ?? 1..1 registered | partial | preliminary | final +   -->
 <category><!-- ?? 0..* CodeableConcept Service category   --></category>
 <code><!-- ?? 1..1 CodeableConcept Name/Code for this diagnostic report   --></code>
 <subject><!-- ?? 0..1 Reference(Patient) 
     The subject of the report - usually, but not always, the patient --></subject>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Health care event when test ordered --></encounter>
 <effective[x]><!-- ?? 0..1 dateTime|Period 
     Clinically relevant time/time-period for report --></effective[x]>
 <issued value="[instant]"/><!-- ?? 0..1 DateTime this version was made -->
 <performer><!-- ?? 0..* Reference(Practitioner) 
     Responsible Diagnostic Service --></performer>
 <resultsInterpreter><!-- ?? 0..* Reference(Practitioner) 
     Primary result interpreter --></resultsInterpreter>
 <specimen><!-- ?? 0..* Reference(Specimen) 
     Specimens this report is based on --></specimen>
 <</result>

 <result><!-- ?? 0..* Reference(Observation) Observations --></result>

 <imagingStudy><!-- ?? 0..* Reference(ImagingStudy) 
     Reference to full details of imaging associated with the diagnostic report --></imagingStudy>
 <

 <media> ?? 0..* BackboneElement  <!-- ?? 0..* Key images associated with this report -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <comment value="[string]"/><!-- ?? 0..1 Comment about the image (e.g. explanation) -->
  <link><!-- ?? 1..1 Reference(Media) 
      Reference to the image source --></link>
 </media>
 <conclusion value="[string]"/><!-- ?? 0..1 Clinical conclusion (interpretation) of test results -->
 <conclusionCode><!-- ?? 0..* CodeableConcept Codes for the clinical conclusion of test results   --></conclusionCode>
 <presentedForm><!-- ?? 0..* Attachment 
     Entire report as issued --></presentedForm>
</DiagnosticReport>

{ // Profile for HLA Genotyping Results
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], // C?Contained, inline Resources

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // 

      { // Allele Database // C?

        // from Element: extension
      },
      { // 

      { // Glstring // C?

        // from Element: extension
      },
      { // 

      { // Haploid // C?

        // from Element: extension
      },
      { // The platform, methodology and software applied at the time of the
genotyping

genotyping // C?

        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "identifier" : [{ Identifier }], // C?Business identifier for report
    "basedOn" : [{ Reference(CarePlan) }], // C?What was requested
    "status" : "<code>", // C? R! registered | partial | preliminary | final +
    "category" : [{ CodeableConcept }], // C?Service category
    "code" : { CodeableConcept }, // C? R! Name/Code for this diagnostic report
    "subject" : { Reference(Patient) }, // C?The subject of the report - usually, but not always, the patient
    "encounter" : { Reference(Encounter) }, // C?Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", // C?Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, // C?Clinically relevant time/time-period for report
    "issued" : "<instant>", // C?DateTime this version was made
    "performer" : [{ Reference(Practitioner) }], // C?Responsible Diagnostic Service
    "resultsInterpreter" : [{ Reference(Practitioner) }], // C?Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], // C?Specimens this report is based on
    "

    "result" : [{ Reference(Observation) }], // C?Observations

    "imagingStudy" : [{ Reference(ImagingStudy) }], // C?Reference to full details of imaging associated with the diagnostic report
    "

    "media" : [{ BackboneElement }], // C?Key images associated with this report

    "conclusion" : "<string>", // C?Clinical conclusion (interpretation) of test results
    "conclusionCode" : [{ CodeableConcept }], // C?Codes for the clinical conclusion of test results
    "presentedForm" : [{ Attachment }], // C?Entire report as issued
  }

Snapshot View

Name Flags Card. Type Description & Constraints doco
. . DiagnosticReport I 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred ) ): IETF language tag
Max Binding:
Additional Bindings Purpose
All Languages Max Binding
. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . Slices for extension I 0..* Extension Extension
Slice: Unordered, Open by value:url
. . . hla-genotyping-results-allele-database I 0..1 CodeableConcept Allele Database
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-allele-database
. . . hla-genotyping-results-glstring I 0..1 (Complex) Glstring
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-glstring
. . . hla-genotyping-results-haploid I 0..* (Complex) Haploid
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-haploid
. . . hla-genotyping-results-method I 0..1 CodeableConcept The platform, methodology and software applied at the time of the genotyping
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-method
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . identifier Σ I 0..* Identifier Business identifier for report
. . . basedOn I 0..* Reference ( CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) What was requested
. . . status ?! Σ I 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus ( required ) ): The status of the diagnostic report.

. . . category Σ I 0..* CodeableConcept Service category
Binding: Diagnostic Service Section Codes ( example ) ): HL7 V2 table 0074


. . . code Σ I 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes ( preferred ) ): LOINC Codes for Diagnostic Reports

. . . subject Σ I 0..1 Reference ( Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance ) The subject of the report - usually, but not always, the patient
. . . encounter Σ I 0..1 Reference ( Encounter ) Health care event when test ordered
. . . effective[x] Σ I 0..1 Clinically relevant time/time-period for report
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . issued Σ I 0..1 instant DateTime this version was made
. . . performer Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Responsible Diagnostic Service
. . . resultsInterpreter Σ I 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam ) Primary result interpreter
. . . specimen I 0..* Reference ( Specimen ) Specimens this report is based on
. . . result I 0..* Reference ( Observation ) Observations
. . . imagingStudy I 0..* Reference ( ImagingStudy ) Reference to full details of imaging associated with the diagnostic report
. . . media Σ I 0..* BackboneElement Key images associated with this report
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . comment I 0..1 string Comment about the image (e.g. explanation)
. . . . link Σ I 1..1 Reference ( Media ) Reference to the image source
. . . conclusion I 0..1 string Clinical conclusion (interpretation) of test results
. . . conclusionCode I 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMED CT Clinical Findings ( example ) ): SNOMED CT Clinical Findings


. . . presentedForm I 0..* Attachment Entire report as issued

doco Documentation for this format

XML Template 

<!-- Profile for HLA Genotyping Results -->doco

<DiagnosticReport xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <

 <contained><!-- ?? 0..* Resource 

     Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- ?? 0..* Identifier 
     Business identifier for report --></identifier>
 <basedOn><!-- ?? 0..* Reference(CarePlan) What was requested --></basedOn>
 <status value="[code]"/><!-- ?? 1..1 registered | partial | preliminary | final +   -->
 <category><!-- ?? 0..* CodeableConcept Service category   --></category>
 <code><!-- ?? 1..1 CodeableConcept Name/Code for this diagnostic report   --></code>
 <subject><!-- ?? 0..1 Reference(Patient) 
     The subject of the report - usually, but not always, the patient --></subject>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Health care event when test ordered --></encounter>
 <effective[x]><!-- ?? 0..1 dateTime|Period 
     Clinically relevant time/time-period for report --></effective[x]>
 <issued value="[instant]"/><!-- ?? 0..1 DateTime this version was made -->
 <performer><!-- ?? 0..* Reference(Practitioner) 
     Responsible Diagnostic Service --></performer>
 <resultsInterpreter><!-- ?? 0..* Reference(Practitioner) 
     Primary result interpreter --></resultsInterpreter>
 <specimen><!-- ?? 0..* Reference(Specimen) 
     Specimens this report is based on --></specimen>
 <</result>

 <result><!-- ?? 0..* Reference(Observation) Observations --></result>

 <imagingStudy><!-- ?? 0..* Reference(ImagingStudy) 
     Reference to full details of imaging associated with the diagnostic report --></imagingStudy>
 <

 <media> ?? 0..* BackboneElement  <!-- ?? 0..* Key images associated with this report -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <comment value="[string]"/><!-- ?? 0..1 Comment about the image (e.g. explanation) -->
  <link><!-- ?? 1..1 Reference(Media) 
      Reference to the image source --></link>
 </media>
 <conclusion value="[string]"/><!-- ?? 0..1 Clinical conclusion (interpretation) of test results -->
 <conclusionCode><!-- ?? 0..* CodeableConcept Codes for the clinical conclusion of test results   --></conclusionCode>
 <presentedForm><!-- ?? 0..* Attachment 
     Entire report as issued --></presentedForm>
</DiagnosticReport>

JSON Template 

{ // Profile for HLA Genotyping Results
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "

    "contained" : [{ Resource }], // C?Contained, inline Resources

    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // 

      { // Allele Database // C?

        // from Element: extension
      },
      { // 

      { // Glstring // C?

        // from Element: extension
      },
      { // 

      { // Haploid // C?

        // from Element: extension
      },
      { // The platform, methodology and software applied at the time of the
genotyping

genotyping // C?

        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "identifier" : [{ Identifier }], // C?Business identifier for report
    "basedOn" : [{ Reference(CarePlan) }], // C?What was requested
    "status" : "<code>", // C? R! registered | partial | preliminary | final +
    "category" : [{ CodeableConcept }], // C?Service category
    "code" : { CodeableConcept }, // C? R! Name/Code for this diagnostic report
    "subject" : { Reference(Patient) }, // C?The subject of the report - usually, but not always, the patient
    "encounter" : { Reference(Encounter) }, // C?Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", // C?Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, // C?Clinically relevant time/time-period for report
    "issued" : "<instant>", // C?DateTime this version was made
    "performer" : [{ Reference(Practitioner) }], // C?Responsible Diagnostic Service
    "resultsInterpreter" : [{ Reference(Practitioner) }], // C?Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], // C?Specimens this report is based on
    "

    "result" : [{ Reference(Observation) }], // C?Observations

    "imagingStudy" : [{ Reference(ImagingStudy) }], // C?Reference to full details of imaging associated with the diagnostic report
    "

    "media" : [{ BackboneElement }], // C?Key images associated with this report

    "conclusion" : "<string>", // C?Clinical conclusion (interpretation) of test results
    "conclusionCode" : [{ CodeableConcept }], // C?Codes for the clinical conclusion of test results
    "presentedForm" : [{ Attachment }], // C?Entire report as issued
  }

 

Alternate definitions: Master Definition ( XML , JSON ), Schematron

10.3.15.2.2 10.3.13.8.2 Terminology Bindings

Path Name Conformance ValueSet
DiagnosticReport.language Common Languages preferred Common Languages
DiagnosticReport.status DiagnosticReportStatus required DiagnosticReportStatus
DiagnosticReport.category Diagnostic Service Section Codes example Diagnostic Service Section Codes
DiagnosticReport.code LOINC Diagnostic Report Codes preferred LOINC Diagnostic Report Codes
DiagnosticReport.conclusionCode SNOMED CT Clinical Findings example SNOMED CT Clinical Findings
.