FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.testing
Resource TypeTestScript
IdTestScript-testscript-example-effective-period.json
FHIR VersionR6
Sourcehttps://build.fhir.org/ig/HL7/fhir-testing-ig/TestScript-testscript-example-effective-period.html
URLhttp://hl7.org/fhir/TestScript/testscript-example-effective-period
Version1.0
Statusdraft
Date2025-07-29
NameTestScriptExampleEffectivePeriodTest
TitleTestScript Example Effective Period Test
Realmuv
Authorityhl7
DescriptionTestScript 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.
PurposeDemonstrate use of artifact-effectivePeriod extension
Copyright© HL7.org 2011+

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: TestScript testscript-example-effective-period

Language: en

Artifact Effective Period: 2019-10-30 --> (ongoing)

url: http://hl7.org/fhir/TestScript/testscript-example-effective-period

identifier: Uniform Resource Identifier (URI)/urn:oid:2.16.840.1.113883.4.642.12.9

version: 1.0

name: TestScriptExampleEffectivePeriodTest

title: TestScript Example Effective Period Test

status: Draft

experimental: false

date: 2025-07-29

publisher: HL7 International / FHIR Infrastructure

contact: Support: support@HL7.org

description:

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.

purpose:

Demonstrate use of artifact-effectivePeriod extension

copyright:

© HL7.org 2011+

Scopes

-ArtifactConformancePhase
*PatientOptionalUnit

profile: Patient

Variables

-NameDefaultValue
*KnownPatientResourceIdexample

test

id

PatientRead

name: Patient Read Test

description: Read a known Patient and validate response.

action

Operations

-TypeResourceDescriptionAcceptEncodeRequestUrlParams
*FHIR Restful Interactions: read (read)http://hl7.org/fhir/StructureDefinition/PatientRead the known Patient resource on the destination test system using the user defined dynamic variable ${KnownPatientResourceId}.xmltrue/${KnownPatientResourceId}

action

Asserts

-DescriptionResponseStopTestOnFailWarningOnly
*Confirm that the returned HTTP status is 200(OK).OKfalsefalse

action

Asserts

-DescriptionContentTypeStopTestOnFailWarningOnly
*Confirm that the returned format is XML.xmlfalsefalse

action

Asserts

-DescriptionStopTestOnFailValidateProfileIdWarningOnly
*Confirm that the returned Patient conforms to the base FHIR specification.falsepatient-profilefalse

Source1

{
  "resourceType": "TestScript",
  "resourceDefinition": "http://hl7.org/fhir/StructureDefinition/TestScript|0.1.0-SNAPSHOT",
  "id": "testscript-example-effective-period",
  "language": "en",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod",
      "valuePeriod": {
        "start": "2019-10-30"
      }
    }
  ],
  "url": "http://hl7.org/fhir/TestScript/testscript-example-effective-period",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.12.9"
    }
  ],
  "version": "1.0",
  "name": "TestScriptExampleEffectivePeriodTest",
  "title": "TestScript Example Effective Period Test",
  "status": "draft",
  "experimental": false,
  "date": "2025-07-29",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "Support",
      "telecom": [
        {
          "system": "email",
          "value": "support@HL7.org",
          "use": "work"
        }
      ]
    }
  ],
  "description": "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.",
  "purpose": "Demonstrate use of artifact-effectivePeriod extension",
  "copyright": "© HL7.org 2011+",
  "scope": [
    {
      "artifact": "http://hl7.org/fhir/StructureDefinition/Patient",
      "conformance": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/testscript-scope-conformance-codes",
            "code": "optional"
          }
        ]
      },
      "phase": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/testscript-scope-phase-codes",
            "code": "unit"
          }
        ]
      }
    }
  ],
  "profile": [
    "http://hl7.org/fhir/StructureDefinition/Patient"
  ],
  "_profile": [
    {
      "id": "patient-profile"
    }
  ],
  "variable": [
    {
      "name": "KnownPatientResourceId",
      "defaultValue": "example"
    }
  ],
  "test": [
    {
      "id": "PatientRead",
      "name": "Patient Read Test",
      "description": "Read a known Patient and validate response.",
      "action": [
        {
          "operation": {
            "type": {
              "system": "http://hl7.org/fhir/restful-interaction",
              "code": "read"
            },
            "resource": "Patient",
            "description": "Read the known Patient resource on the destination test system using the user defined dynamic variable ${KnownPatientResourceId}.",
            "accept": "xml",
            "encodeRequestUrl": true,
            "params": "/${KnownPatientResourceId}"
          }
        },
        {
          "assert": {
            "description": "Confirm that the returned HTTP status is 200(OK).",
            "response": "okay",
            "stopTestOnFail": false,
            "warningOnly": false
          }
        },
        {
          "assert": {
            "description": "Confirm that the returned format is XML.",
            "contentType": "xml",
            "stopTestOnFail": false,
            "warningOnly": false
          }
        },
        {
          "assert": {
            "description": "Confirm that the returned Patient conforms to the base FHIR specification.",
            "stopTestOnFail": false,
            "validateProfileId": "patient-profile",
            "warningOnly": false
          }
        }
      ]
    }
  ]
}