CDSi CDS-Immunization Forecast Implementation Guide - STU 1 Ballot (v0.1.0)

This page is part of the Immunization Decision Support Forecast FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

D.1.0 StructureDefinition: CDS-Immunization-Patient

The official URL for this profile is: 

http://hl7.org/fhir/uv/cdsi/StructureDefinition/cdsi-patient

Defines constraints and extensions on the Patient resource for the minimal set of data to be used in an immunization forecast.

This profile builds on Patient.

This profile was published on Thu Apr 27 00:00:00 AEST 2017 as a draft by PHER.

D.1.0.1 Formal Views of Profile Content

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

This structure is derived from Patient

Summary

Mandatory: 2 elements
Prohibited: 14 elements

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... identifier 0..0
... active 0..0
... name 0..0
... telecom 0..0
... gender 1..1codeBinding: AdministrativeGender (required)
... birthDate 1..1date
... address 0..0
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... animal 0..0
... communication 0..0
... generalPractitioner 0..0
... managingOrganization 0..0
... link 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*Information about an individual or animal receiving health care services
... 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
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ1..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not

doco Documentation for this format

yet to be done: Xml template

// { "resourceType" : "Patient", "id" : "<id>", // Logical id of this artifact "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": [ ], "gender" : "<code>", // R! male | female | other | unknown "birthDate" : "<date>", // R! The date of birth for the individual // deceased[x]: Indicates if the individual is deceased or not. One of these 2: "deceasedBoolean" : <boolean>, // Indicates if the individual is deceased or not "deceasedDateTime" : "<dateTime>" // Indicates if the individual is deceased or not }

This structure is derived from Patient.

Summary

Mandatory: 2 elements
Prohibited: 14 elements

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... identifier 0..0
... active 0..0
... name 0..0
... telecom 0..0
... gender 1..1codeBinding: AdministrativeGender (required)
... birthDate 1..1date
... address 0..0
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... animal 0..0
... communication 0..0
... generalPractitioner 0..0
... managingOrganization 0..0
... link 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*Information about an individual or animal receiving health care services
... 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
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ1..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1boolean, dateTimeIndicates if the individual is deceased or not

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

// { "resourceType" : "Patient", "id" : "<id>", // Logical id of this artifact "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": [ ], "gender" : "<code>", // R! male | female | other | unknown "birthDate" : "<date>", // R! The date of birth for the individual // deceased[x]: Indicates if the individual is deceased or not. One of these 2: "deceasedBoolean" : <boolean>, // Indicates if the individual is deceased or not "deceasedDateTime" : "<dateTime>" // Indicates if the individual is deceased or not }

 

D.1.0.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Patient.languageCommon LanguagesextensibleCommon Languages
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.contact.relationshipv2 Contact Roleextensiblev2 Contact Role
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedsexampleAnimalBreeds
Patient.animal.genderStatusGenderStatusexampleGenderStatus
Patient.communication.languageCommon LanguagesextensibleCommon Languages
Patient.link.typeLinkTyperequiredLinkType

D.1.0.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2PatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1PatientIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4PatientIf 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-3PatientIf 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()