R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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 R3

10.3.14.2 StructureDefinition: HLAResult

Orders and Observations Work Group Maturity Level: 1Trial 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+1000 as a draft by Health Level Seven International (Clinical Genomics).

10.3.14.2.1 Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hla-genotyping-results-allele-database I0..1CodeableConceptAllele Database
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-allele-database
... hla-genotyping-results-glstring I0..1(Complex)Glstring
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-glstring
... hla-genotyping-results-haploid I0..*(Complex)Haploid
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-haploid
... hla-genotyping-results-method I0..1CodeableConceptThe platform, methodology and software applied at the time of the genotyping
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-method
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category Σ0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
... code Σ1..1CodeableConceptName/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes (preferred)
... subject Σ0..1Reference(Patient | Group | Device | Location)The subject of the report - usually, but not always, the patient
... context Σ0..1Reference(Encounter | EpisodeOfCare)Health care event when test ordered
... effective[x] Σ0..1dateTime, PeriodClinically relevant time/time-period for report
... issued Σ0..1instantDateTime this version was made
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result 0..*Reference(Observation)Observations
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media ΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical conclusion (interpretation) of test results
... conclusionCode 0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: SNOMED CT Clinical Findings (example)
... presentedForm 0..*AttachmentEntire report as issued

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

<DiagnosticReport xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <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..1 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>
 <context><!-- 0..1 Reference(Encounter) 
     Health care event when test ordered --></context>
 <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><!-- 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 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 }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //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 // C?
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Business identifier for report
    "basedOn" : [{ Reference(CarePlan) }], //What was requested
    "status" : "<code>", // R! registered | partial | preliminary | final +
    "category" : { CodeableConcept }, //Service category
    "code" : { CodeableConcept }, // R! Name/Code for this diagnostic report
    "subject" : { Reference(Patient) }, //The subject of the report - usually, but not always, the patient
    "context" : { Reference(Encounter) }, //Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, //Clinically relevant time/time-period for report
    "issued" : "<instant>", //DateTime this version was made
    "performer" : [{ Reference(Practitioner) }], //Responsible Diagnostic Service
    "resultsInterpreter" : [{ Reference(Practitioner) }], //Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], //Specimens this report is based on
    "result" : [{ Reference(Observation) }], //Observations
    "imagingStudy" : [{ Reference(ImagingStudy) }], //Reference to full details of imaging associated with the diagnostic report
    "media" : [{ BackboneElement }], // C?Key images associated with this report
    "conclusion" : "<string>", //Clinical conclusion (interpretation) of test results
    "conclusionCode" : [{ CodeableConcept }], //Codes for the clinical conclusion of test results
    "presentedForm" : [{ Attachment }], //Entire report as issued
  }

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hla-genotyping-results-allele-database I0..1CodeableConceptAllele Database
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-allele-database
... hla-genotyping-results-glstring I0..1(Complex)Glstring
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-glstring
... hla-genotyping-results-haploid I0..*(Complex)Haploid
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-haploid
... hla-genotyping-results-method I0..1CodeableConceptThe platform, methodology and software applied at the time of the genotyping
URL: http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-method
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!Σ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category Σ0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
... code Σ1..1CodeableConceptName/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes (preferred)
... subject Σ0..1Reference(Patient | Group | Device | Location)The subject of the report - usually, but not always, the patient
... context Σ0..1Reference(Encounter | EpisodeOfCare)Health care event when test ordered
... effective[x] Σ0..1dateTime, PeriodClinically relevant time/time-period for report
... issued Σ0..1instantDateTime this version was made
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result 0..*Reference(Observation)Observations
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media ΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical conclusion (interpretation) of test results
... conclusionCode 0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: SNOMED CT Clinical Findings (example)
... presentedForm 0..*AttachmentEntire 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 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..1 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>
 <context><!-- 0..1 Reference(Encounter) 
     Health care event when test ordered --></context>
 <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><!-- 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 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 }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //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 // C?
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Business identifier for report
    "basedOn" : [{ Reference(CarePlan) }], //What was requested
    "status" : "<code>", // R! registered | partial | preliminary | final +
    "category" : { CodeableConcept }, //Service category
    "code" : { CodeableConcept }, // R! Name/Code for this diagnostic report
    "subject" : { Reference(Patient) }, //The subject of the report - usually, but not always, the patient
    "context" : { Reference(Encounter) }, //Health care event when test ordered
// value[x]: Clinically relevant time/time-period for report. One of these 2:
    "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for report
    "effectivePeriod" : { Period }, //Clinically relevant time/time-period for report
    "issued" : "<instant>", //DateTime this version was made
    "performer" : [{ Reference(Practitioner) }], //Responsible Diagnostic Service
    "resultsInterpreter" : [{ Reference(Practitioner) }], //Primary result interpreter
    "specimen" : [{ Reference(Specimen) }], //Specimens this report is based on
    "result" : [{ Reference(Observation) }], //Observations
    "imagingStudy" : [{ Reference(ImagingStudy) }], //Reference to full details of imaging associated with the diagnostic report
    "media" : [{ BackboneElement }], // C?Key images associated with this report
    "conclusion" : "<string>", //Clinical conclusion (interpretation) of test results
    "conclusionCode" : [{ CodeableConcept }], //Codes for the clinical conclusion of test results
    "presentedForm" : [{ Attachment }], //Entire report as issued
  }

 

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

10.3.14.2.2 Terminology Bindings

PathNameConformanceValueSet
DiagnosticReport.languageLanguagepreferredLanguage
DiagnosticReport.statusDiagnosticReportStatusrequiredDiagnosticReportStatus
DiagnosticReport.categoryDiagnostic Service Section CodesexampleDiagnostic Service Section Codes
DiagnosticReport.codeLOINC Diagnostic Report CodespreferredLOINC Diagnostic Report Codes
DiagnosticReport.conclusionCodeSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings
.