Standard Health Record FHIR Implementation Guide

SHR HIVScreeningTestRequested Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-HIVScreeningTestRequested

A request for a rapid HIV screening test.

This profile builds on Basic.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Basic.extension.valueCodeableConcept.coding is sliced based on the value of value:code

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.procedure.HIVScreeningTestRequested maps to Basic:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR HIVScreeningTestRequested Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-procedure-HIVScreeningTestRequested"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 1..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
.... valueCodeableConcept Binding: SHR HIVScreeningTestCodeVS ValueSet (required)
... shr-core-Category-extension 0..1CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... valueCodeableConcept
..... coding Slice: Unordered, Open by value:code
..... coding Σ0..*Coding
...... system Fixed Value: http://hl7.org/fhir/observation-category
...... code Fixed Value: laboratory
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-entity-BodySite-extension 0..*Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-entity-PartOf-extension 0..1(Complex)SHR PartOf Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-PartOf-extension
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-entity-Specimen-extension 0..1Reference(SHR Specimen Profile)SHR Specimen Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Specimen-extension
... shr-device-Device-extension 0..1Reference(SHR Device Profile)SHR Device Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-device-Device-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR HIVScreeningTestRequested Profile
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 1..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR HIVScreeningTestCodeVS ValueSet (required)
... shr-core-Category-extension 0..1CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding Σ0..*Coding
...... id 0..1stringxml:id (or equivalent in JSON)
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-entity-Patient-extension 0..1Reference(SHR Patient Profile)SHR Patient Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Patient-extension
.... shr-entity-Group-extension 0..1Reference(SHR Group Profile)SHR Group Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Group-extension
.... shr-device-Device-extension 0..1Reference(SHR Device Profile)SHR Device Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-device-Device-extension
.... shr-core-Location-extension 0..1(Complex)SHR Location Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Location-extension
.... shr-entity-RelatedPerson-extension 0..1Reference(SHR RelatedPerson Profile)SHR RelatedPerson Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-RelatedPerson-extension
.... shr-entity-Organization-extension 0..1Reference(SHR Organization Profile)SHR Organization Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Organization-extension
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension"
... shr-entity-BodySite-extension 0..*Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-entity-PartOf-extension 0..1(Complex)SHR PartOf Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-PartOf-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-base-Content-extension 1..1(Complex)SHR Content Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Content-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
..... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
..... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Content-extension"
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-PartOf-extension"
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-entity-Specimen-extension 0..1Reference(SHR Specimen Profile)SHR Specimen Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Specimen-extension
... shr-device-Device-extension 0..1Reference(SHR Device Profile)SHR Device Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-device-Device-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-procedure-HIVScreeningTestRequested"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Basic.extension.valueCodeableConcept.coding is sliced based on the value of value:code

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.procedure.HIVScreeningTestRequested maps to Basic:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR HIVScreeningTestRequested Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-procedure-HIVScreeningTestRequested"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 1..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
.... valueCodeableConcept Binding: SHR HIVScreeningTestCodeVS ValueSet (required)
... shr-core-Category-extension 0..1CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... valueCodeableConcept
..... coding Slice: Unordered, Open by value:code
..... coding Σ0..*Coding
...... system Fixed Value: http://hl7.org/fhir/observation-category
...... code Fixed Value: laboratory
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-entity-BodySite-extension 0..*Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-entity-PartOf-extension 0..1(Complex)SHR PartOf Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-PartOf-extension
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-entity-Specimen-extension 0..1Reference(SHR Specimen Profile)SHR Specimen Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Specimen-extension
... shr-device-Device-extension 0..1Reference(SHR Device Profile)SHR Device Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-device-Device-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR HIVScreeningTestRequested Profile
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 1..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR HIVScreeningTestCodeVS ValueSet (required)
... shr-core-Category-extension 0..1CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code
..... coding Σ0..*Coding
...... id 0..1stringxml:id (or equivalent in JSON)
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/observation-category
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-entity-Patient-extension 0..1Reference(SHR Patient Profile)SHR Patient Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Patient-extension
.... shr-entity-Group-extension 0..1Reference(SHR Group Profile)SHR Group Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Group-extension
.... shr-device-Device-extension 0..1Reference(SHR Device Profile)SHR Device Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-device-Device-extension
.... shr-core-Location-extension 0..1(Complex)SHR Location Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Location-extension
.... shr-entity-RelatedPerson-extension 0..1Reference(SHR RelatedPerson Profile)SHR RelatedPerson Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-RelatedPerson-extension
.... shr-entity-Organization-extension 0..1Reference(SHR Organization Profile)SHR Organization Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Organization-extension
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension"
... shr-entity-BodySite-extension 0..*Reference(SHR BodySite Profile)SHR BodySite Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-BodySite-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... shr-entity-PartOf-extension 0..1(Complex)SHR PartOf Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-PartOf-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-base-Content-extension 1..1(Complex)SHR Content Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Content-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
..... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
..... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Content-extension"
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-PartOf-extension"
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-entity-Specimen-extension 0..1Reference(SHR Specimen Profile)SHR Specimen Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Specimen-extension
... shr-device-Device-extension 0..1Reference(SHR Device Profile)SHR Device Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-device-Device-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-procedure-HIVScreeningTestRequested"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Basic.languageCommon LanguagesextensibleCommon Languages
Basic.extension.valueCodeableConceptSHR HIVScreeningTestCodeVS ValueSetrequiredSHR HIVScreeningTestCodeVS ValueSet
Basic.codeBasic Resource TypesexampleBasic Resource Types

 

Constraints

IdPathDetailsRequirements
dom-2BasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BasicIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BasicIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3BasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()