0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: PatientDeidentSTU3

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/STU3/StructureDefinition/profile-patient-deident-stu3

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from Patient

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 15 elements

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* |  | CRD Deidentified Patient
text |  | 0..0 |  |
identifier |  | 0..0 |  |
name |  | 0..0 |  |
telecom |  | 0..0 |  |
gender | S | 1..1 | code |
birthDate | S | 0..1 | date |
deceased[x] |  | 0..0 |  |
address | S | 0..* | Address |
use |  | 0..1 | code |
type | S | 0..1 | code |
text |  | 0..0 |  |
line |  | 0..0 |  |
city |  | 0..0 |  |
district |  | 0..0 |  |
state | S | 0..1 | string |
postalCode |  | 0..0 |  |
country | S | 0..1 | string |
period |  | 0..0 |  |
multipleBirth[x] |  | 0..0 |  |
photo |  | 0..0 |  |
contact |  | 0..0 |  |
communication | S | 0..* | BackboneElement |
language | S | 1..1 | CodeableConcept |
link |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | I | 0..* |  | CRD Deidentified Patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 0..1 | date | The date of birth for the individual
address | S Σ | 0..* | Address | Addresses for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General': home
type | S Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
animal | ?!Σ I | 0..1 | BackboneElement | This patient is known to be an animal (non-human)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example)
breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example)
genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example)
communication | S I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) Max Binding: All Languages
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 8 elements
Prohibited: 15 elements

Differential View

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* |  | CRD Deidentified Patient
text |  | 0..0 |  |
identifier |  | 0..0 |  |
name |  | 0..0 |  |
telecom |  | 0..0 |  |
gender | S | 1..1 | code |
birthDate | S | 0..1 | date |
deceased[x] |  | 0..0 |  |
address | S | 0..* | Address |
use |  | 0..1 | code |
type | S | 0..1 | code |
text |  | 0..0 |  |
line |  | 0..0 |  |
city |  | 0..0 |  |
district |  | 0..0 |  |
state | S | 0..1 | string |
postalCode |  | 0..0 |  |
country | S | 0..1 | string |
period |  | 0..0 |  |
multipleBirth[x] |  | 0..0 |  |
photo |  | 0..0 |  |
contact |  | 0..0 |  |
communication | S | 0..* | BackboneElement |
language | S | 1..1 | CodeableConcept |
link |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient | I | 0..* |  | CRD Deidentified Patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 0..1 | date | The date of birth for the individual
address | S Σ | 0..* | Address | Addresses for the individual
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General': home
type | S Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok)
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
maritalStatus |  | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible)
animal | ?!Σ I | 0..1 | BackboneElement | This patient is known to be an animal (non-human)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example)
breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example)
genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example)
communication | S I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) Max Binding: All Languages
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
Documentation for this format

Other representations of profile: Schematron

### Terminology Bindings

Path | Conformance | ValueSet
Patient.gender | required | AdministrativeGender
Patient.address.type | required | AddressType
Patient.communication.language | extensible | Common Languages Max Binding: All Languages

### Constraints

Id | Path | Details | Requirements
dom-2 | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-1 | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() |
dom-4 | Patient | If 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-3 | Patient | If 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() |
ele-1 | Patient.animal | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
ele-1 | Patient.communication | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |