FHIR Testing IG
0.1.0-SNAPSHOT - Draft International flag

FHIR Testing IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.1.0-SNAPSHOT built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-testing-ig/ and changes regularly. See the Directory of published versions

: TestScript Example Effective Period Test

Page standards status: Informative

Raw xml | Download

​
<TestScript xmlns="http://hl7.org/fhir">
  <id value="testscript-example-effective-period"/>
  <language value="en"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><p class="res-header-id"><b>Generated Narrative: TestScript testscript-example-effective-period</b></p><a name="testscript-example-effective-period"> </a><a name="hctestscript-example-effective-period"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Language: en</p></div><p><b>Artifact Effective Period</b>: 2019-10-30 --&gt; (ongoing)</p><p><b>url</b>: <a href="http://hl7.org/fhir/TestScript/testscript-example-effective-period">http://hl7.org/fhir/TestScript/testscript-example-effective-period</a></p><p><b>identifier</b>: <a href="http://terminology.hl7.org/6.5.0/NamingSystem-uri.html" title="As defined by RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt)(with many schemes defined in many RFCs). For OIDs and UUIDs, use the URN form (urn:oid:(note: lowercase) and urn:uuid:). See http://www.ietf.org/rfc/rfc3001.txt and http://www.ietf.org/rfc/rfc4122.txt 

This oid is used as an identifier II.root to indicate the the extension is an absolute URI (technically, an IRI). Typically, this is used for OIDs and GUIDs. Note that when this OID is used with OIDs and GUIDs, the II.extension should start with urn:oid or urn:uuid: 

Note that this OID is created to aid with interconversion between CDA and FHIR - FHIR uses urn:ietf:rfc:3986 as equivalent to this OID. URIs as identifiers appear more commonly in FHIR.

This OID may also be used in CD.codeSystem.">Uniform Resource Identifier (URI)</a>/urn:oid:2.16.840.1.113883.4.642.12.9</p><p><b>version</b>: 1.0</p><p><b>title</b>: TestScript Example Effective Period Test</p><p><b>status</b>: Draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2025-07-29</p><p><b>publisher</b>: HL7</p><p><b>contact</b>: Support: <a href="mailto:support@HL7.org">support@HL7.org</a></p><p><b>description</b>: </p><div><p>TestScript example resource the demonstrates the use of the artifact-effectivePeriod extenstion. There is a single test for a Patient read operation. The effective period range represents the period of use for the FHIR R4 v4.0.1 specification starting from its release date on Oct 30, 2019 with no expiration.</p>
</div><p><b>jurisdiction</b>: <span title="Codes:{urn:iso:std:iso:3166 US}">United States of America</span></p><p><b>purpose</b>: </p><div><p>Demonstrate use of artifact-effectivePeriod extension</p>
</div><p><b>copyright</b>: </p><div><p>© HL7.org 2011+</p>
</div><blockquote><p><b>metadata</b></p><h3>Links</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Url</b></td><td><b>Description</b></td></tr><tr><td style="display: none">*</td><td><a href="http://hl7.org/fhir/patient.html">http://hl7.org/fhir/patient.html</a></td><td>Demographics and other administrative information about an individual or animal receiving care or other health-related services.</td></tr></table><h3>Capabilities</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Required</b></td><td><b>Validated</b></td><td><b>Description</b></td><td><b>Link</b></td><td><b>Capabilities</b></td></tr><tr><td style="display: none">*</td><td>true</td><td>false</td><td>Patient Read Operation</td><td><a href="http://hl7.org/fhir/http.html#read">http://hl7.org/fhir/http.html#read</a></td><td><code>http://hl7.org/fhir/CapabilityStatement/example</code></td></tr></table></blockquote><h3>Scopes</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Artifact</b></td><td><b>Conformance</b></td><td><b>Phase</b></td></tr><tr><td style="display: none">*</td><td><a href="http://hl7.org/fhir/R5/patient.html">Patient</a></td><td><span title="Codes:{http://hl7.org/fhir/testscript-scope-conformance-codes optional}">Optional</span></td><td><span title="Codes:{http://hl7.org/fhir/testscript-scope-phase-codes unit}">Unit</span></td></tr></table><p><b>profile</b>: <a href="http://hl7.org/fhir/R5/patient.html">Patient</a></p><h3>Variables</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Name</b></td><td><b>DefaultValue</b></td></tr><tr><td style="display: none">*</td><td>KnownPatientResourceId</td><td>example</td></tr></table><blockquote><p><b>test</b></p><blockquote><p><b>id</b></p>PatientRead</blockquote><p><b>name</b>: Patient Read Test</p><p><b>description</b>: Read a known Patient and validate response.</p><blockquote><p><b>action</b></p></blockquote></blockquote><p><b style="color: maroon">Exception Generating Narrative: Unable to resolve content reference http://hl7.org/fhir/StructureDefinition/TestScript#TestScript.setup.action.operation trying to resolve TestScript.test.action.operation </b></p></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod">
    <valuePeriod>
      <start value="2019-10-30"/>
    </valuePeriod>
  </extension>
  <url
       value="http://hl7.org/fhir/TestScript/testscript-example-effective-period"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.12.9"/>
  </identifier>
  <version value="1.0"/>
  <title value="TestScript Example Effective Period Test"/>
  <status value="draft"/>
  <experimental value="true"/>
  <date value="2025-07-29"/>
  <publisher value="HL7"/>
  <contact>
    <name value="Support"/>
    <telecom>
      <system value="email"/>
      <value value="support@HL7.org"/>
      <use value="work"/>
    </telecom>
  </contact>
  <description
               value="TestScript example resource the demonstrates the use of the artifact-effectivePeriod extenstion. There is a single test for a Patient read operation. The effective period range represents the period of use for the FHIR R4 v4.0.1 specification starting from its release date on Oct 30, 2019 with no expiration."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <purpose value="Demonstrate use of artifact-effectivePeriod extension"/>
  <copyright value="© HL7.org 2011+"/>
  <metadata>
    <link>
      <url value="http://hl7.org/fhir/patient.html"/>
      <description
                   value="Demographics and other administrative information about an individual or animal receiving care or other health-related services."/>
    </link>
    <capability>
      <required value="true"/>
      <validated value="false"/>
      <description value="Patient Read Operation"/>
      <link value="http://hl7.org/fhir/http.html#read"/>
      <capabilities value="http://hl7.org/fhir/CapabilityStatement/example"/>
    </capability>
  </metadata>
  <scope>
    <artifact value="http://hl7.org/fhir/StructureDefinition/Patient"/>
    <conformance>
      <coding>
        <system
                value="http://hl7.org/fhir/testscript-scope-conformance-codes"/>
        <code value="optional"/>
      </coding>
    </conformance>
    <phase>
      <coding>
        <system value="http://hl7.org/fhir/testscript-scope-phase-codes"/>
        <code value="unit"/>
      </coding>
    </phase>
  </scope>
  <profile value="http://hl7.org/fhir/StructureDefinition/Patient">🔗 
    <id value="patient-profile"/>
  </profile>
  <variable>
    <name value="KnownPatientResourceId"/>
    <defaultValue value="example"/>
  </variable>
  <test id="PatientRead">
    <name value="Patient Read Test"/>
    <description value="Read a known Patient and validate response."/>
    <action>
      <operation>
        <type>
          <system value="http://hl7.org/fhir/restful-interaction"/>
          <code value="read"/>
        </type>
        <resource value="Patient"/>
        <description
                     value="Read the known Patient resource on the destination test system using the user defined dynamic variable ${KnownPatientResourceId}."/>
        <accept value="xml"/>
        <encodeRequestUrl value="true"/>
        <params value="/${KnownPatientResourceId}"/>
      </operation>
    </action>
    <action>
      <assert>
        <description
                     value="Confirm that the returned HTTP status is 200(OK)."/>
        <response value="okay"/>
        <stopTestOnFail value="false"/>
        <warningOnly value="false"/>
      </assert>
    </action>
    <action>
      <assert>
        <description value="Confirm that the returned format is XML."/>
        <contentType value="xml"/>
        <stopTestOnFail value="false"/>
        <warningOnly value="false"/>
      </assert>
    </action>
    <action>
      <assert>
        <description
                     value="Confirm that the returned Patient conforms to the base FHIR specification."/>
        <stopTestOnFail value="false"/>
        <validateProfileId value="patient-profile"/>
        <warningOnly value="false"/>
      </assert>
    </action>
  </test>
</TestScript>